HTTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The HTTPServer class offers server-side functionality for the HTTP/HTTPS protocols.

Syntax

HTTPServer

Remarks

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

Follow the below steps to set up and run the server in your code:

• Create an instance of the server component and set up the license, if assumed by the edition you are using: var server = new Httpserver(); server.RuntimeLicense = "5342..0000";
• Set up the listening port (make sure it is not in use): server.Port = 443;
• Tell the component whether TLS connections should be enforced: server.UseTLS = true; // set to false to disable TLS and server plain HTTP requests
• Set up the document root (a directory where all static files are kept): server.DocumentRoot = "c:\\inetpub\\mywebserver";
• (TLS-enabled servers only) Configure TLS parameters. The exact way of doing that may vary for different scenarios and security requirements. At the very least you need to set up the certificate chain that the server will use to authenticate itself to connecting clients. If you don"t, the component will generate a dummy certificate itself, however, that certificate is unlikely to pass any security requirements. It will let you accept test connections though.

  Below is an example of tuning up the TLS parameters of the server: // *** Switching TLS on and enabling the implicit mode *** server.UseTLS = true; server.TLSSettings.TLSMode = smImplicitTLS; // this must be implicit for HTTPS // Loading the certificate chain var mgr = new Certificatemanager(); mgr.RuntimeLicense = "5342..0000"; // *** Setting up the host certificate *** // - it should be issued in the name that matches the hostname (such as domain.com) or its IP address (1.2.3.4), // - it must have an associated private key - so likely is provided in PFX or PEM format. mgr.ImportFromFile("CertTLSServer.pfx", "password"); server.ServerCertificates.Add(mgr.Certificate); // The CA certificate: this is to help connecting clients validate the chain. mgr.ImportFromFile("CertCA.cer", ""); server.ServerCertificates.Add(mgr.Certificate); // *** Adjusting finer-grained TLS settings *** // - session resumption (allows for faster handshakes for connections from the same origin) server.TLSSettings.UseSessionResumption = true; // - secure configuration server.TLSSettings.BaseConfiguration = stpcHighlySecure; // - disabling a cipher suite we dislike (just because we can): server.TLSSettings.Ciphersuites = "-DHE_RSA_AES128_SHA" // *** Configuring versions *** // The default version setting at the time of writing (May 2021) is TLS 1.2 and TLS 1.3, // but that may change in future versions. The following tune-up additionally activates TLS 1.1 and TLS 1.0, // which weakens security, but may be necessary to accept connections from older clients: server.TLSSettings.Versions = csbTLS1 | csbTLS11 | csbTLS12 | csbTLS13;

• Now that your server has been fully set up, activate it: server.Start();
• Once the Start call completes, your server can accept connections from clients. Each accepted connection runs in a separate thread, not interfering with each other or your own threads. The server communicates its ongoing activities to your application by throwing events. The lower-level events deal with the underlying network connections:
  • Accept notifies you about a new incoming connection. This event lets you accept or reject it.
  • Connect notifies your code of an accepted connection. This event introduces a ConnectionID, a unique identifier that you can use to track the connection throughout its lifetime.
  • Disconnect notifies you that a connection has been closed.
  • TLSEstablished and TLSShutdown let you know that a TLS layer has been activated/deactivated.
  • Error reports a protocol or other error.
  • CertificateValidate communicates the client authentication event to your code. To access the certificate(s) provided by the authenticating client, pin the client and use the PinnedClientChain property to access its chain: server.PinClient(e.ConnectionID); e.Accept = CheckCert(server.PinnedClientChain);
  The higher-level events let you know what is going on at the HTTP layer, and let you serve your content on the fly:
  • GetRequest fires when a GET request is received from a connection.
  • PostRequest notifies your code about a POST request. Similar events for other HTTP request types (e.g. DELETE) are also available.
  • AuthAttempt fires when a connected client tries HTTP authentication (such as basic or digest) and let you accept or reject it.

  Note: every such event is thrown from the respective connection thread, so make sure you use some synchronization mechanism when dispatching the events to your UI thread - for example, by updating UI controls by sending a Window Message rather than accessing the controls directly.

• Use GetRequestStream, GetRequestString, and GetRequestHeader methods inside your GetRequest and similar event handlers to access request parameters and content supplied by the client. Use SetResponseHeader and SetResponseString method to supply the response content: void serverGetRequest(object sender, EventArgs e) { e.Handled = true; // telling the Httpserver object that we will supply our own content if (e.URI == "/index.html") { server.SetResponseStatus(e.ConnectionID, 200); server.SetResponseString(e.ConnectionID, "<html><head></head><body>Hello!</body></html>", "text/html"); } else if (e.URI == "/secretfile") { server.SetResponseStatus(e.ConnectionID, 200); server.SetResponseBytes(e.ConnectionID, m_secretData, "application/pdf"); } else if (e.URI.StartsWith("/static/")) { e.Handled = false; // letting the server process the content and flush the file from the home directory (c:\inetpub\mywebserver) } else { Flush404Page(e.ConnectionID); } }
• To stop the server, call Stop: server.Stop();

HTTPServer and SSLLabs

Having said that, when assessing SecureBlackbox TLS-capable servers that are configured to use their default setup, you will often end up with a lower SSLLabs score than you could have. There is a simple reason for that. Being a vendor of a library used by thousands of customers, we have to find a delicate balance between security, compatibility, and keeping class contracts rolling from one product build to another. This makes the default configuration of the components not the strongest possible. To put it simple, we could easily make the default component setup bulletproof - but having done that, we would have likely ended up with hundreds of customers stuck with legacy environments (and there are a lot of them around) losing their connectivity.

If you are looking at achieving the best score at SSLLabs, please read on. The below guidance aims to help you tune up the server component in the way that should give you an A score.

First, switch your server to the highly secure base configuration: server.TLSSettings.BaseConfiguration = stpcHighlySecure; This should immediately give you an A, or a T if your server certificate does not chain up to a trusted anchor.

Some warnings will still be included in the report. One of those is related to the session resumption. It is normally shown in orange:

Session resumption (caching): No (IDs assigned but not accepted)

This literally means that the server is not configured to re-use older sessions, which may put extra computational burden on clients and itself. Use the following setting to enable session caching: server.TLSSettings.UseSessionResumption = true;

Besides, the report may show that there are some weak ciphersuites. All of those should be shown in orange (there should not be any reds; if there are - please let us know), which means they are only relatively weak. While switching them off may affect the interoperability level of the server, you may still want to do that. By using the below approach you can disable individual ciphersuites selectively. For example, if the report shows that TLS_DHE_RSA_WITH_AES128_CBC_SHA256 and TLS_DHE_RSA_WITH_AES256_CBC_SHA256 are weak (because of their CBC mode), you can disable them in the following way: server.TLSSettings.Ciphersuites = '-DHE_RSA_AES128_SHA256;-DHE_RSA_AES256_SHA256'; Note that SBB uses slightly different, simpler naming convention by dropping unnecessart WITH and CBC. Let us know if you have difficulties matching the cipher suite names.

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 (HTTPServer 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_httpserver_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

AllowKeepAlive Property (HTTPServer Class)

Enables or disables keep-alive mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAllowKeepAlive();
int SetAllowKeepAlive(int bAllowKeepAlive);

Unicode (Windows)
BOOL GetAllowKeepAlive();
INT SetAllowKeepAlive(BOOL bAllowKeepAlive);

int secureblackbox_httpserver_getallowkeepalive(void* lpObj);
int secureblackbox_httpserver_setallowkeepalive(void* lpObj, int bAllowKeepAlive);

bool GetAllowKeepAlive();
int SetAllowKeepAlive(bool bAllowKeepAlive);

Default Value

TRUE

Remarks

Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while.

Data Type

Boolean

AuthBasic Property (HTTPServer 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_httpserver_getauthbasic(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getauthdigest(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getauthdigestexpire(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getauthrealm(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer Class)

Indicates the bound listening port.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();

int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getclientauth(void* lpObj);
int secureblackbox_httpserver_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

CompressionLevel Property (HTTPServer Class)

The default compression level to use.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_httpserver_getcompressionlevel(void* lpObj);
int secureblackbox_httpserver_setcompressionlevel(void* lpObj, int iCompressionLevel);

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

Default Value

6

Remarks

Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest.

Data Type

Integer

DocumentRoot Property (HTTPServer 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_httpserver_getdocumentroot(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_geterrororigin(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_geterrorseverity(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_httpserver_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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (HTTPServer 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_httpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_httpserver_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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (HTTPServer 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_httpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_httpserver_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 extra protection layer for the protocol and diminishes the risk of 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (HTTPServer 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_httpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer Class)

Provide 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_httpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_httpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (HTTPServer 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_httpserver_getfipsmode(void* lpObj);
int secureblackbox_httpserver_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

HandshakeTimeout Property (HTTPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);

Unicode (Windows)
INT GetHandshakeTimeout();
INT SetHandshakeTimeout(INT iHandshakeTimeout);

int secureblackbox_httpserver_gethandshaketimeout(void* lpObj);
int secureblackbox_httpserver_sethandshaketimeout(void* lpObj, int iHandshakeTimeout);

int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (HTTPServer 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_httpserver_gethost(void* lpObj);
int secureblackbox_httpserver_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

PinnedClientAddress Property (HTTPServer Class)

The client's IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientAddress();

Unicode (Windows)
LPWSTR GetPinnedClientAddress();

char* secureblackbox_httpserver_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 (HTTPServer Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientChainValidationDetails();

Unicode (Windows)
INT GetPinnedClientChainValidationDetails();

int secureblackbox_httpserver_getpinnedclientchainvalidationdetails(void* lpObj);

int GetPinnedClientChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest what 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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The cipher suite employed by this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCiphersuite();

Unicode (Windows)
LPWSTR GetPinnedClientCiphersuite();

char* secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The client connection's unique identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientID();

Unicode (Windows)
LONG64 GetPinnedClientID();

int64 secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The elliptic curve used in this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientNamedECCurve();

Unicode (Windows)
LPWSTR GetPinnedClientNamedECCurve();

char* secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The remote port of the client connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPort();

Unicode (Windows)
INT GetPinnedClientPort();

int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPublicKeyBits();

Unicode (Windows)
INT GetPinnedClientPublicKeyBits();

int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The signature algorithm used in a TLS handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientSignatureAlgorithm();

char* secureblackbox_httpserver_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 (HTTPServer Class)

The block size of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricBlockSize();

Unicode (Windows)
INT GetPinnedClientSymmetricBlockSize();

int secureblackbox_httpserver_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 (HTTPServer Class)

The key length of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricKeyBits();

Unicode (Windows)
INT GetPinnedClientSymmetricKeyBits();

int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

Contains the server certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientValidationLog();

Unicode (Windows)
LPWSTR GetPinnedClientValidationLog();

char* secureblackbox_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

The number of records in the PinnedClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCount();

Unicode (Windows)
INT GetPinnedClientCertCount();

int secureblackbox_httpserver_getpinnedclientcertcount(void* lpObj);

int GetPinnedClientCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• 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 (HTTPServer Class)

Returns 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_httpserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

Remarks

Returns 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

PinnedClientCertCAKeyID Property (HTTPServer 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_httpserver_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

PinnedClientCertFingerprint Property (HTTPServer 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_httpserver_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

PinnedClientCertHandle Property (HTTPServer 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_httpserver_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. 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

PinnedClientCertIssuer Property (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer 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_httpserver_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 (HTTPServer Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetPinnedClientCertKeyBits(INT iPinnedClientCertIndex);

int secureblackbox_httpserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);

int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);

Default Value

0

Remarks

Returns the length of the 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

Integer

PinnedClientCertKeyFingerprint Property (HTTPServer Class)

Returns a fingerprint of the public key contained in the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex, char* &lpPinnedClientCertKeyFingerprint, int &lenPinnedClientCertKeyFingerprint);

Unicode (Windows)
INT GetPinnedClientCertKeyFingerprint(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertKeyFingerprint, INT &lenPinnedClientCertKeyFingerprint);

int secureblackbox_httpserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertKeyFingerprint, int* lenPinnedClientCertKeyFingerprint);

QByteArray GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);

Remarks

Returns a fingerprint of the public key contained in 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

Byte Array

PinnedClientCertKeyUsage Property (HTTPServer Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetPinnedClientCertKeyUsage(INT iPinnedClientCertIndex);

int secureblackbox_httpserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);

int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

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

Integer

PinnedClientCertPublicKeyBytes Property (HTTPServer Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex, char* &lpPinnedClientCertPublicKeyBytes, int &lenPinnedClientCertPublicKeyBytes);

Unicode (Windows)
INT GetPinnedClientCertPublicKeyBytes(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertPublicKeyBytes, INT &lenPinnedClientCertPublicKeyBytes);

int secureblackbox_httpserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);

QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);

Remarks

Contains the certificate's public key 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

PinnedClientCertSelfSigned Property (HTTPServer Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetPinnedClientCertSelfSigned(INT iPinnedClientCertIndex);

int secureblackbox_httpserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);

bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

PinnedClientCertSerialNumber Property (HTTPServer Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex, char* &lpPinnedClientCertSerialNumber, int &lenPinnedClientCertSerialNumber);

Unicode (Windows)
INT GetPinnedClientCertSerialNumber(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertSerialNumber, INT &lenPinnedClientCertSerialNumber);

int secureblackbox_httpserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);

QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);

Remarks

Returns the certificate's serial number.

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

PinnedClientCertSigAlgorithm Property (HTTPServer Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPinnedClientCertSigAlgorithm(INT iPinnedClientCertIndex);

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

QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign 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

PinnedClientCertSubject Property (HTTPServer Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPinnedClientCertSubject(INT iPinnedClientCertIndex);

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

QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or 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

PinnedClientCertSubjectKeyID Property (HTTPServer Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex, char* &lpPinnedClientCertSubjectKeyID, int &lenPinnedClientCertSubjectKeyID);

Unicode (Windows)
INT GetPinnedClientCertSubjectKeyID(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertSubjectKeyID, INT &lenPinnedClientCertSubjectKeyID);

int secureblackbox_httpserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);

QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject 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

Byte Array

PinnedClientCertSubjectRDN Property (HTTPServer Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPinnedClientCertSubjectRDN(INT iPinnedClientCertIndex);

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

QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

PinnedClientCertValidFrom Property (HTTPServer Class)

The time point at which the certificate becomes valid, in UTC.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPinnedClientCertValidFrom(INT iPinnedClientCertIndex);

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

QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

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

PinnedClientCertValidTo Property (HTTPServer Class)

The time point at which the certificate expires, in UTC.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPinnedClientCertValidTo(INT iPinnedClientCertIndex);

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

QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

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

Port Property (HTTPServer Class)

Specifies the port number to listen for connections on.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_httpserver_getport(void* lpObj);
int secureblackbox_httpserver_setport(void* lpObj, int iPort);

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

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Data Type

Integer

PortRangeFrom Property (HTTPServer Class)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom);

Unicode (Windows)
INT GetPortRangeFrom();
INT SetPortRangeFrom(INT iPortRangeFrom);

int secureblackbox_httpserver_getportrangefrom(void* lpObj);
int secureblackbox_httpserver_setportrangefrom(void* lpObj, int iPortRangeFrom);

int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom);

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

PortRangeTo Property (HTTPServer Class)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo);

Unicode (Windows)
INT GetPortRangeTo();
INT SetPortRangeTo(INT iPortRangeTo);

int secureblackbox_httpserver_getportrangeto(void* lpObj);
int secureblackbox_httpserver_setportrangeto(void* lpObj, int iPortRangeTo);

int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo);

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

ServerCertCount Property (HTTPServer Class)

The number of records in the ServerCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);

Unicode (Windows)
INT GetServerCertCount();
INT SetServerCertCount(INT iServerCertCount);

int secureblackbox_httpserver_getservercertcount(void* lpObj);
int secureblackbox_httpserver_setservercertcount(void* lpObj, int iServerCertCount);

int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertHandle

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (HTTPServer Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertBytes(int iServerCertIndex, char* &lpServerCertBytes, int &lenServerCertBytes);

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);

int secureblackbox_httpserver_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns raw certificate data in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertHandle Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, int64 lServerCertHandle);

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);
INT SetServerCertHandle(INT iServerCertIndex, LONG64 lServerCertHandle);

int64 secureblackbox_httpserver_getservercerthandle(void* lpObj, int servercertindex);
int secureblackbox_httpserver_setservercerthandle(void* lpObj, int servercertindex, int64 lServerCertHandle);

qint64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, qint64 lServerCertHandle);

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is not available at design time.

Data Type

Long64

SessionTimeout Property (HTTPServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout);

Unicode (Windows)
INT GetSessionTimeout();
INT SetSessionTimeout(INT iSessionTimeout);

int secureblackbox_httpserver_getsessiontimeout(void* lpObj);
int secureblackbox_httpserver_setsessiontimeout(void* lpObj, int iSessionTimeout);

int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout);

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

Data Type

Integer

SocketIncomingSpeedLimit Property (HTTPServer 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_httpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getsocketlocalport(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getsockettimeout(void* lpObj);
int secureblackbox_httpserver_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 (HTTPServer 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_httpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_httpserver_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

TLSAutoValidateCertificates Property (HTTPServer Class)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates);

Unicode (Windows)
BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);

int secureblackbox_httpserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_httpserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

TRUE

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (HTTPServer Class)

Selects the base configuration for the TLS settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Unicode (Windows)
INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

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

int secureblackbox_httpserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_httpserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (HTTPServer Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites);

Unicode (Windows)
LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);

char* secureblackbox_httpserver_gettlsciphersuites(void* lpObj);
int secureblackbox_httpserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

Default Value

""

Remarks

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

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSECCurves Property (HTTPServer Class)

Defines the elliptic curves to enable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves);

Unicode (Windows)
LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);

char* secureblackbox_httpserver_gettlseccurves(void* lpObj);
int secureblackbox_httpserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (HTTPServer Class)

Provides access to TLS extensions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions);

Unicode (Windows)
LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);

char* secureblackbox_httpserver_gettlsextensions(void* lpObj);
int secureblackbox_httpserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (HTTPServer Class)

Whether to force TLS session resumption when the destination address changes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges);

Unicode (Windows)
BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);

int secureblackbox_httpserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_httpserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

FALSE

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity);

Unicode (Windows)
LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);

char* secureblackbox_httpserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_httpserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (HTTPServer Class)

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey);

Unicode (Windows)
LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);

char* secureblackbox_httpserver_gettlspresharedkey(void* lpObj);
int secureblackbox_httpserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

""

Remarks

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (HTTPServer Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite);

Unicode (Windows)
LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);

char* secureblackbox_httpserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_httpserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (HTTPServer Class)

Selects renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Unicode (Windows)
INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1), 
CRAPM_AUTO(2)

int secureblackbox_httpserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_httpserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (HTTPServer Class)

Specifies the kind(s) of revocation check to perform.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Unicode (Windows)
INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

int secureblackbox_httpserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_httpserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (HTTPServer Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Unicode (Windows)
INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);

int secureblackbox_httpserver_gettlsssloptions(void* lpObj);
int secureblackbox_httpserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (HTTPServer Class)

Specifies the TLS mode to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

int secureblackbox_httpserver_gettlstlsmode(void* lpObj);
int secureblackbox_httpserver_settlstlsmode(void* lpObj, int iTLSTLSMode);

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (HTTPServer Class)

Enables Extended Master Secret Extension, as defined in RFC 7627.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_httpserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_httpserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

FALSE

Remarks

Enables Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (HTTPServer Class)

Enables or disables TLS session resumption capability.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_httpserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_httpserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (HTTPServer Class)

The SSL/TLS versions to enable by default.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_httpserver_gettlsversions(void* lpObj);
int secureblackbox_httpserver_settlsversions(void* lpObj, int iTLSVersions);

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UseChunkedTransfer Property (HTTPServer Class)

Enables chunked transfer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseChunkedTransfer();
int SetUseChunkedTransfer(int bUseChunkedTransfer);

Unicode (Windows)
BOOL GetUseChunkedTransfer();
INT SetUseChunkedTransfer(BOOL bUseChunkedTransfer);

int secureblackbox_httpserver_getusechunkedtransfer(void* lpObj);
int secureblackbox_httpserver_setusechunkedtransfer(void* lpObj, int bUseChunkedTransfer);

bool GetUseChunkedTransfer();
int SetUseChunkedTransfer(bool bUseChunkedTransfer);

Default Value

FALSE

Remarks

Use this property to enable chunked content encoding.

Data Type

Boolean

UseCompression Property (HTTPServer Class)

Enables or disables server-side compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseCompression();
int SetUseCompression(int bUseCompression);

Unicode (Windows)
BOOL GetUseCompression();
INT SetUseCompression(BOOL bUseCompression);

int secureblackbox_httpserver_getusecompression(void* lpObj);
int secureblackbox_httpserver_setusecompression(void* lpObj, int bUseCompression);

bool GetUseCompression();
int SetUseCompression(bool bUseCompression);

Default Value

FALSE

Remarks

Use this property to enable or disable server-side content compression.

Data Type

Boolean

UserCount Property (HTTPServer Class)

The number of records in the User arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCount();
int SetUserCount(int iUserCount);

Unicode (Windows)
INT GetUserCount();
INT SetUserCount(INT iUserCount);

int secureblackbox_httpserver_getusercount(void* lpObj);
int secureblackbox_httpserver_setusercount(void* lpObj, int iUserCount);

int GetUserCount();
int SetUserCount(int iUserCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCert
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (HTTPServer Class)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserAssociatedData(int iUserIndex, char* &lpUserAssociatedData, int &lenUserAssociatedData);
int SetUserAssociatedData(int iUserIndex, const char* lpUserAssociatedData, int lenUserAssociatedData);

Unicode (Windows)
INT GetUserAssociatedData(INT iUserIndex, LPSTR &lpUserAssociatedData, INT &lenUserAssociatedData);
INT SetUserAssociatedData(INT iUserIndex, LPCSTR lpUserAssociatedData, INT lenUserAssociatedData);

int secureblackbox_httpserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_httpserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);

QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (HTTPServer Class)

Base path for this user in the server's file system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, const char* lpszUserBasePath);

Unicode (Windows)
LPWSTR GetUserBasePath(INT iUserIndex);
INT SetUserBasePath(INT iUserIndex, LPCWSTR lpszUserBasePath);

char* secureblackbox_httpserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);

QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCert Property (HTTPServer Class)

Contains the user's certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCert(int iUserIndex, char* &lpUserCert, int &lenUserCert);
int SetUserCert(int iUserIndex, const char* lpUserCert, int lenUserCert);

Unicode (Windows)
INT GetUserCert(INT iUserIndex, LPSTR &lpUserCert, INT &lenUserCert);
INT SetUserCert(INT iUserIndex, LPCSTR lpUserCert, INT lenUserCert);

int secureblackbox_httpserver_getusercert(void* lpObj, int userindex, char** lpUserCert, int* lenUserCert);
int secureblackbox_httpserver_setusercert(void* lpObj, int userindex, const char* lpUserCert, int lenUserCert);

QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserData Property (HTTPServer Class)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, const char* lpszUserData);

Unicode (Windows)
LPWSTR GetUserData(INT iUserIndex);
INT SetUserData(INT iUserIndex, LPCWSTR lpszUserData);

char* secureblackbox_httpserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);

QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, int64 lUserHandle);

Unicode (Windows)
LONG64 GetUserHandle(INT iUserIndex);
INT SetUserHandle(INT iUserIndex, LONG64 lUserHandle);

int64 secureblackbox_httpserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);

qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (HTTPServer Class)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

• C++
• C
• Qt