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

Qualys SSLLabs (https://www.ssllabs.com/) has been long known as a comprehensive TLS site quality checking tool. It is now a de-facto standard and a sign of good taste to aspire for the best SSLLabs test result for your web presence. SecureBlackbox developers share that effort and want to help their customers build secure TLS endpoints that can be independently endorsed by third-party evaluators like 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.


Active	Indicates whether the server is active and is listening to new connections.
AllowCustomRequests	Allows custom requests.
AllowKeepAlive	Enables or disables keep-alive mode.
AuthRealm	Specifies authentication realm for digest and NTLM authentication.
AuthTypes	Defines allowed HTTP authentication types.
BoundPort	Indicates the bound listening port.
CompressionLevel	The default compression level to use.
DocumentRoot	The document root of the server.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
HandshakeTimeout	Specifies the handshake timeout in milliseconds.
Host	The host to bind the listening port to.
PinnedClient	Populates the pinned client details.
PinnedClientChain	Contains the certificate chain of the pinned client.
Port	Specifies the port number to listen for connections on.
PortRangeFrom	Specifies the lower limit of the listening port range for incoming connections.
PortRangeTo	Specifies the upper limit of the listening port range for incoming connections.
SessionTimeout	Specifies the default session timeout value in milliseconds.
SocketSettings	Manages network connection settings.
TLSServerChain	The server's TLS certificates.
TLSSettings	Manages TLS layer settings.
UseChunkedTransfer	Enables chunked transfer.
UseCompression	Enables or disables server-side compression.
Users	Provides a list of registered users.
WebsiteName	Specifies the web site name to use in the certificate.

Method List

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


Cleanup	Cleans up the server environment by purging expired sessions and cleaning caches.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
DropClient	Terminates a client connection.
GetRequestBytes	Returns the contents of the client's HTTP request.
GetRequestHeader	Returns a request header value.
GetRequestStream	Returns the contents of the client's HTTP request.
GetRequestString	Returns the contents of the client's HTTP request.
GetRequestUsername	Returns the username for a connection.
GetResponseHeader	Returns a response header value.
ListClients	Enumerates the connected clients.
PinClient	Takes a snapshot of the connection's properties.
ProcessGenericRequest	Processes a generic HTTP request.
ProcessGenericRequestStream	Processes a generic HTTP request from a stream.
Reset	Resets the class settings.
SetResponseBytes	Sets a byte array to be served as a response.
SetResponseFile	Sets a file to be served as a response.
SetResponseHeader	Sets a response header.
SetResponseStatus	Sets an HTTP status to be sent with the response.
SetResponseStream	Sets a stream to be served as a response.
SetResponseString	Sets a string to be served as a response.
Start	Starts the server.
Stop	Stops the server.

Event List

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


Accept	Reports an incoming connection.
AuthAttempt	Fires when a connected client makes an authentication attempt.
Connect	Reports an accepted connection.
CustomRequest	Reports a request of a non-standard type (method).
Data	Supplies a data chunk received within a POST or PUT upload.
DeleteRequest	Reports a DELETE request.
Disconnect	Fires to report a disconnected client.
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the server protocol.
FileError	Reports a file access error to the application.
GetRequest	Reports a GET request.
HeadersPrepared	Fires when the response headers have been formed and are ready to be sent to the server.
HeadRequest	Reports a HEAD request.
Notification	This event notifies the application about an underlying control flow event.
OptionsRequest	Reports an OPTIONS request.
PatchRequest	Reports a PATCH request.
PostRequest	Reports a POST request.
PutRequest	Reports a PUT request.
ResourceAccess	Reports an attempt to access a resource.
TLSCertValidate	Fires when a client certificate needs to be validated.
TLSEstablished	Reports the setup of a TLS session.
TLSHandshake	Fires when a newly established client connection initiates a TLS handshake.
TLSPSK	Requests a pre-shared key for TLS-PSK.
TLSShutdown	Reports closure of a TLS session.
TraceRequest	Reports a TRACE request.

Config Settings

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


AllowKeepAlive	Enables or disables keep-alive mode.
AllowOptionsResponseWithoutAuth	Enables unauthenticated responses to OPTIONS requests.
AuthBasic	Turns on/off the basic authentication.
AuthDigest	Turns on/off the digest authentication.
AuthDigestExpire	Specifies digest expiration time for digest authentication.
AuthRealm	Specifies authentication realm for digest and NTLM authentication.
BoundAddress	Returns the bound address of the listening socket.
BoundPort	The port that was bound by the server.
CompressionLevel	The default compression level to use.
DocumentRoot	The document root of the server.
DualStack	Allows the use of ip4 and ip6 simultaneously.
HandshakeTimeout	The HTTPS handshake timeout.
HomePage	Specifies the home page resource name.
Host	The host to bind to.
Port	The port to listen on.
PortRangeFrom	The lower bound of allowed port scope to listen on.
PortRangeTo	The higher bound of allowed port scope to listen on.
PreSharedIdentityHint	Gets or sets the PSK identity hint.
RequestFilter	The request string modifier.
SessionTimeout	The HTTP session timeout.
SleepLen	Adjusts the server loop idling time.
TempDir	A temporary directory to use.
TempPath	Path for storing temporary files.
TLSExtensions	TBD.
TLSPeerExtensions	TBD.
TLSServerCertIndex	Specifies the index of the server certificate to use.
UseChunkedTransfer	Enables chunked transfer.
UseCompression	Enables or disables server-side compression.
WebsiteName	The website name for the TLS certificate.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Active Property (HTTPServer Class)

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

Syntax

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

AllowCustomRequests Property (HTTPServer Class)

Allows custom requests.

Syntax

ANSI (Cross Platform)
int GetAllowCustomRequests();
int SetAllowCustomRequests(int bAllowCustomRequests);

Unicode (Windows)
BOOL GetAllowCustomRequests();
INT SetAllowCustomRequests(BOOL bAllowCustomRequests);

int secureblackbox_httpserver_getallowcustomrequests(void* lpObj);
int secureblackbox_httpserver_setallowcustomrequests(void* lpObj, int bAllowCustomRequests);

bool GetAllowCustomRequests();
int SetAllowCustomRequests(bool bAllowCustomRequests);

Default Value

FALSE

Remarks

Use this property to allow custom requests.

Data Type

Boolean

AllowKeepAlive Property (HTTPServer Class)

Enables or disables keep-alive mode.

Syntax

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

AuthRealm Property (HTTPServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

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

AuthTypes Property (HTTPServer Class)

Defines allowed HTTP authentication types.

Syntax

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

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

int secureblackbox_httpserver_getauthtypes(void* lpObj);
int secureblackbox_httpserver_setauthtypes(void* lpObj, int iAuthTypes);

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

Default Value

Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:


haBasic	`0x01`	Basic authentication
haDigest	`0x02`	Digest authentication (RFC 2617)
haNTLM	`0x04`	Windows NTLM authentication
haKerberos	`0x08`	Kerberos (Negotiate) authentication
haOAuth2	`0x10`	OAuth2 authentication

Data Type

Integer

BoundPort Property (HTTPServer Class)

Indicates the bound listening port.

Syntax

ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();

int secureblackbox_httpserver_getboundport(void* lpObj);

int GetBoundPort();

Default Value

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

CompressionLevel Property (HTTPServer Class)

The default compression level to use.

Syntax

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

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

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

ExternalCrypto Property (HTTPServer Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_httpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_httpserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_httpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_httpserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_httpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_httpserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_httpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_httpserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_httpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_httpserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_httpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_httpserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_httpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_httpserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_httpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_httpserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_httpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_httpserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_httpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_httpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

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

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

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

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

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

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

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

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

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

Remarks

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

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (HTTPServer Class)

Reserved.

Syntax

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

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

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

PinnedClient Property (HTTPServer Class)

Populates the pinned client details.

Syntax

SecureBlackboxTLSConnectionInfo* GetPinnedClient();

int secureblackbox_httpserver_getpinnedclientaeadcipher(void* lpObj);

int secureblackbox_httpserver_getpinnedclientchainvalidationdetails(void* lpObj);

int secureblackbox_httpserver_getpinnedclientchainvalidationresult(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientciphersuite(void* lpObj);

int secureblackbox_httpserver_getpinnedclientclientauthenticated(void* lpObj);

int secureblackbox_httpserver_getpinnedclientclientauthrequested(void* lpObj);

int secureblackbox_httpserver_getpinnedclientconnectionestablished(void* lpObj);

int secureblackbox_httpserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);

char* secureblackbox_httpserver_getpinnedclientdigestalgorithm(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientencryptionalgorithm(void* lpObj);

int secureblackbox_httpserver_getpinnedclientexportable(void* lpObj);

int64 secureblackbox_httpserver_getpinnedclientid(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientkeyexchangealgorithm(void* lpObj);

int secureblackbox_httpserver_getpinnedclientkeyexchangekeybits(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientnamedeccurve(void* lpObj);

int secureblackbox_httpserver_getpinnedclientpfscipher(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientpresharedidentity(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientpresharedidentityhint(void* lpObj);

int secureblackbox_httpserver_getpinnedclientpublickeybits(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientremoteaddress(void* lpObj);

int secureblackbox_httpserver_getpinnedclientremoteport(void* lpObj);

int secureblackbox_httpserver_getpinnedclientresumedsession(void* lpObj);

int secureblackbox_httpserver_getpinnedclientsecureconnection(void* lpObj);

int secureblackbox_httpserver_getpinnedclientserverauthenticated(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientsignaturealgorithm(void* lpObj);

int secureblackbox_httpserver_getpinnedclientsymmetricblocksize(void* lpObj);

int secureblackbox_httpserver_getpinnedclientsymmetrickeybits(void* lpObj);

int64 secureblackbox_httpserver_getpinnedclienttotalbytesreceived(void* lpObj);

int64 secureblackbox_httpserver_getpinnedclienttotalbytessent(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientvalidationlog(void* lpObj);

char* secureblackbox_httpserver_getpinnedclientversion(void* lpObj);

bool GetPinnedClientAEADCipher();

int GetPinnedClientChainValidationDetails();

int GetPinnedClientChainValidationResult();

QString GetPinnedClientCiphersuite();

bool GetPinnedClientClientAuthenticated();

bool GetPinnedClientClientAuthRequested();

bool GetPinnedClientConnectionEstablished();

QByteArray GetPinnedClientConnectionID();

QString GetPinnedClientDigestAlgorithm();

QString GetPinnedClientEncryptionAlgorithm();

bool GetPinnedClientExportable();

qint64 GetPinnedClientID();

QString GetPinnedClientKeyExchangeAlgorithm();

int GetPinnedClientKeyExchangeKeyBits();

QString GetPinnedClientNamedECCurve();

bool GetPinnedClientPFSCipher();

QString GetPinnedClientPreSharedIdentity();

QString GetPinnedClientPreSharedIdentityHint();

int GetPinnedClientPublicKeyBits();

QString GetPinnedClientRemoteAddress();

int GetPinnedClientRemotePort();

bool GetPinnedClientResumedSession();

bool GetPinnedClientSecureConnection();

bool GetPinnedClientServerAuthenticated();

QString GetPinnedClientSignatureAlgorithm();

int GetPinnedClientSymmetricBlockSize();

int GetPinnedClientSymmetricKeyBits();

qint64 GetPinnedClientTotalBytesReceived();

qint64 GetPinnedClientTotalBytesSent();

QString GetPinnedClientValidationLog();

QString GetPinnedClientVersion();

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

Data Type

SecureBlackboxTLSConnectionInfo

PinnedClientChain Property (HTTPServer Class)

Contains the certificate chain of the pinned client.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();

int secureblackbox_httpserver_getpinnedclientcertcount(void* lpObj);

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

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

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

int64 secureblackbox_httpserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);

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

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

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

int secureblackbox_httpserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);

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

int secureblackbox_httpserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);

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

int secureblackbox_httpserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);

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

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

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

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

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

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

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

int GetPinnedClientCertCount();

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);

qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);

bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);

QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Data Type

SecureBlackboxCertificate

Port Property (HTTPServer Class)

Specifies the port number to listen for connections on.

Syntax

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

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

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

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

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

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

SessionTimeout Property (HTTPServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

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

SocketSettings Property (HTTPServer Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_httpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_httpserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

char* secureblackbox_httpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_httpserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

int secureblackbox_httpserver_getsocketlocalport(void* lpObj);
int secureblackbox_httpserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int secureblackbox_httpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_httpserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int secureblackbox_httpserver_getsockettimeout(void* lpObj);
int secureblackbox_httpserver_setsockettimeout(void* lpObj, int iSocketTimeout);

int secureblackbox_httpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_httpserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

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

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

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

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

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

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

TLSServerChain Property (HTTPServer Class)

The server's TLS certificates.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_httpserver_gettlsservercertcount(void* lpObj);
int secureblackbox_httpserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);

int secureblackbox_httpserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

int64 secureblackbox_httpserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_httpserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);

int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount);

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSSettings Property (HTTPServer Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

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

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

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

int secureblackbox_httpserver_gettlsclientauth(void* lpObj);
int secureblackbox_httpserver_settlsclientauth(void* lpObj, int iTLSClientAuth);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth);

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

UseChunkedTransfer Property (HTTPServer Class)

Enables chunked transfer.

Syntax

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

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

Users Property (HTTPServer Class)

Provides a list of registered users.

Syntax

SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers();
int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);

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

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

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

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

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

char* secureblackbox_httpserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);

int secureblackbox_httpserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);

int secureblackbox_httpserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_httpserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);

char* secureblackbox_httpserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);

int secureblackbox_httpserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_httpserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);

char* secureblackbox_httpserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_httpserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);

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

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

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

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

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

QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);

int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);

QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);

QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the class.

This property is not available at design time.

Data Type

SecureBlackboxUserAccount

WebsiteName Property (HTTPServer Class)

Specifies the web site name to use in the certificate.

Syntax

ANSI (Cross Platform)
char* GetWebsiteName();
int SetWebsiteName(const char* lpszWebsiteName);

Unicode (Windows)
LPWSTR GetWebsiteName();
INT SetWebsiteName(LPCWSTR lpszWebsiteName);

char* secureblackbox_httpserver_getwebsitename(void* lpObj);
int secureblackbox_httpserver_setwebsitename(void* lpObj, const char* lpszWebsiteName);

QString GetWebsiteName();
int SetWebsiteName(QString qsWebsiteName);

Default Value

"secureblackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Data Type

String

Cleanup Method (HTTPServer Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

ANSI (Cross Platform)
int Cleanup();

Unicode (Windows)
INT Cleanup();

int secureblackbox_httpserver_cleanup(void* lpObj);

int Cleanup();

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Error Handling (C++)

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

Config Method (HTTPServer Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

DoAction Method (HTTPServer Class)

Performs an additional action.

Syntax

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

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

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

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

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

Error Handling (C++)

DropClient Method (HTTPServer Class)

Terminates a client connection.

Syntax

ANSI (Cross Platform)
int DropClient(int64 lConnectionId, int bForced);

Unicode (Windows)
INT DropClient(LONG64 lConnectionId, BOOL bForced);

int secureblackbox_httpserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);

int DropClient(qint64 lConnectionId, bool bForced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

Error Handling (C++)

GetRequestBytes Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

ANSI (Cross Platform)
char* GetRequestBytes(int64 lConnectionId, const char* lpszRequestFilter, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetRequestBytes(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, LPINT lpSize = NULL);

char* secureblackbox_httpserver_getrequestbytes(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter, int *lpSize);

QByteArray GetRequestBytes(qint64 lConnectionId, const QString& qsRequestFilter);

Remarks

Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:


params	Request query parameters only.
params[Index]	A specific request parameter, by index.
params['Name']	A specific request parameter, by name.
parts[Index]	The body of a particular part of a multipart message.

Error Handling (C++)

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

GetRequestHeader Method (HTTPServer Class)

Returns a request header value.

Syntax

ANSI (Cross Platform)
char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);

char* secureblackbox_httpserver_getrequestheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);

QString GetRequestHeader(qint64 lConnectionId, const QString& qsHeaderName);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

Error Handling (C++)

GetRequestStream Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

ANSI (Cross Platform)
int GetRequestStream(int64 lConnectionId, const char* lpszRequestFilter, SecureBlackboxStream* sOutputStream);

Unicode (Windows)
INT GetRequestStream(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, SecureBlackboxStream* sOutputStream);

int secureblackbox_httpserver_getrequeststream(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter, SecureBlackboxStream* sOutputStream);

int GetRequestStream(qint64 lConnectionId, const QString& qsRequestFilter, SecureBlackboxStream* sOutputStream);

Remarks

Use this method to get the body of the client's HTTP request into a stream. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:


params	Request query parameters only.
params[Index]	A specific request parameter, by index.
params['Name']	A specific request parameter, by name.
parts[Index]	The body of a particular part of a multipart message.

Error Handling (C++)

GetRequestString Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

ANSI (Cross Platform)
char* GetRequestString(int64 lConnectionId, const char* lpszRequestFilter);

Unicode (Windows)
LPWSTR GetRequestString(LONG64 lConnectionId, LPCWSTR lpszRequestFilter);

char* secureblackbox_httpserver_getrequeststring(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter);

QString GetRequestString(qint64 lConnectionId, const QString& qsRequestFilter);

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.


params	Request query parameters only.
params[Index]	A specific request parameter, by index.
params['Name']	A specific request parameter, by name.
parts[Index]	The body of a particular part of a multipart message.

Error Handling (C++)

GetRequestUsername Method (HTTPServer Class)

Returns the username for a connection.

Syntax

ANSI (Cross Platform)
char* GetRequestUsername(int64 lConnectionId);

Unicode (Windows)
LPWSTR GetRequestUsername(LONG64 lConnectionId);

char* secureblackbox_httpserver_getrequestusername(void* lpObj, int64 lConnectionId);

QString GetRequestUsername(qint64 lConnectionId);

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

Error Handling (C++)

GetResponseHeader Method (HTTPServer Class)

Returns a response header value.

Syntax

ANSI (Cross Platform)
char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);

char* secureblackbox_httpserver_getresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);

QString GetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName);

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

Error Handling (C++)

ListClients Method (HTTPServer Class)

Enumerates the connected clients.

Syntax

ANSI (Cross Platform)
char* ListClients();

Unicode (Windows)
LPWSTR ListClients();

char* secureblackbox_httpserver_listclients(void* lpObj);

QString ListClients();

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

Error Handling (C++)

PinClient Method (HTTPServer Class)

Takes a snapshot of the connection's properties.

Syntax

ANSI (Cross Platform)
int PinClient(int64 lConnectionId);

Unicode (Windows)
INT PinClient(LONG64 lConnectionId);

int secureblackbox_httpserver_pinclient(void* lpObj, int64 lConnectionId);

int PinClient(qint64 lConnectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

Error Handling (C++)

ProcessGenericRequest Method (HTTPServer Class)

Processes a generic HTTP request.

Syntax

ANSI (Cross Platform)
char* ProcessGenericRequest(int64 lConnectionId, const char* lpRequestBytes, int lenRequestBytes, int *lpSize = NULL);

Unicode (Windows)
LPSTR ProcessGenericRequest(LONG64 lConnectionId, LPCSTR lpRequestBytes, INT lenRequestBytes, LPINT lpSize = NULL);

char* secureblackbox_httpserver_processgenericrequest(void* lpObj, int64 lConnectionId, const char* lpRequestBytes, int lenRequestBytes, int *lpSize);

QByteArray ProcessGenericRequest(qint64 lConnectionId, QByteArray qbaRequestBytes);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

Error Handling (C++)

ProcessGenericRequestStream Method (HTTPServer Class)

Processes a generic HTTP request from a stream.

Syntax

ANSI (Cross Platform)
int ProcessGenericRequestStream(int64 lConnectionId, const char* lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);

Unicode (Windows)
INT ProcessGenericRequestStream(LONG64 lConnectionId, LPCWSTR lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);

int secureblackbox_httpserver_processgenericrequeststream(void* lpObj, int64 lConnectionId, const char* lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);

int ProcessGenericRequestStream(qint64 lConnectionId, const QString& qsRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

The method expects the request headers in RequestHeaders, and the request data is read from RequestData stream. Once the request is processed, the response headers are reported through HeadersPrepared event before any data is written to ResponseData stream. ConnectionId allows to identify the request in the events.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application.

Error Handling (C++)

Reset Method (HTTPServer Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_httpserver_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

SetResponseBytes Method (HTTPServer Class)

Sets a byte array to be served as a response.

Syntax

ANSI (Cross Platform)
int SetResponseBytes(int64 lConnectionId, const char* lpBytes, int lenBytes, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseBytes(LONG64 lConnectionId, LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);

int secureblackbox_httpserver_setresponsebytes(void* lpObj, int64 lConnectionId, const char* lpBytes, int lenBytes, const char* lpszContentType, const char* lpszResponseFilter);

int SetResponseBytes(qint64 lConnectionId, QByteArray qbaBytes, const QString& qsContentType, const QString& qsResponseFilter);

Remarks

Use this property to provide the response content in a byte array. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:


parts[Index]	The body of a particular part of a multipart response.

Error Handling (C++)

SetResponseFile Method (HTTPServer Class)

Sets a file to be served as a response.

Syntax

ANSI (Cross Platform)
int SetResponseFile(int64 lConnectionId, const char* lpszFileName, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseFile(LONG64 lConnectionId, LPCWSTR lpszFileName, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);

int secureblackbox_httpserver_setresponsefile(void* lpObj, int64 lConnectionId, const char* lpszFileName, const char* lpszContentType, const char* lpszResponseFilter);

int SetResponseFile(qint64 lConnectionId, const QString& qsFileName, const QString& qsContentType, const QString& qsResponseFilter);

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:


parts[Index]	The body of a particular part of a multipart response.

Error Handling (C++)

SetResponseHeader Method (HTTPServer Class)

Sets a response header.

Syntax

ANSI (Cross Platform)
int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);

Unicode (Windows)
INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);

int secureblackbox_httpserver_setresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);

int SetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName, const QString& qsValue);

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

Error Handling (C++)

SetResponseStatus Method (HTTPServer Class)

Sets an HTTP status to be sent with the response.

Syntax

ANSI (Cross Platform)
int SetResponseStatus(int64 lConnectionId, int iStatusCode);

Unicode (Windows)
INT SetResponseStatus(LONG64 lConnectionId, INT iStatusCode);

int secureblackbox_httpserver_setresponsestatus(void* lpObj, int64 lConnectionId, int iStatusCode);

int SetResponseStatus(qint64 lConnectionId, int iStatusCode);

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as GetRequest.

Error Handling (C++)

SetResponseStream Method (HTTPServer Class)

Sets a stream to be served as a response.

Syntax

ANSI (Cross Platform)
int SetResponseStream(int64 lConnectionId, SecureBlackboxStream* sDataStream, int bCloseStream, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseStream(LONG64 lConnectionId, SecureBlackboxStream* sDataStream, BOOL bCloseStream, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);

int secureblackbox_httpserver_setresponsestream(void* lpObj, int64 lConnectionId, SecureBlackboxStream* sDataStream, int bCloseStream, const char* lpszContentType, const char* lpszResponseFilter);

int SetResponseStream(qint64 lConnectionId, SecureBlackboxStream* sDataStream, bool bCloseStream, const QString& qsContentType, const QString& qsResponseFilter);

Remarks

Use this property to provide the response content in a stream. Set CloseStream to indicate that the stream should be disposed of once sent. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:


parts[Index]	The body of a particular part of a multipart response.

Error Handling (C++)

SetResponseString Method (HTTPServer Class)

Sets a string to be served as a response.

Syntax

ANSI (Cross Platform)
int SetResponseString(int64 lConnectionId, const char* lpszDataStr, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseString(LONG64 lConnectionId, LPCWSTR lpszDataStr, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);

int secureblackbox_httpserver_setresponsestring(void* lpObj, int64 lConnectionId, const char* lpszDataStr, const char* lpszContentType, const char* lpszResponseFilter);

int SetResponseString(qint64 lConnectionId, const QString& qsDataStr, const QString& qsContentType, const QString& qsResponseFilter);

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:


parts[Index]	The body of a particular part of a multipart response.

Error Handling (C++)

Start Method (HTTPServer Class)

Starts the server.

Syntax

ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();

int secureblackbox_httpserver_start(void* lpObj);

int Start();

Remarks

Use this method to activate the server and start listening to incoming connections.

Error Handling (C++)

Stop Method (HTTPServer Class)

Stops the server.

Syntax

ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();

int secureblackbox_httpserver_stop(void* lpObj);

int Stop();

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Error Handling (C++)

Accept Event (HTTPServer Class)

Reports an incoming connection.

Syntax

ANSI (Cross Platform)
virtual int FireAccept(HTTPServerAcceptEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int Accept;
  int reserved;
} HTTPServerAcceptEventParams;


Unicode (Windows)
virtual INT FireAccept(HTTPServerAcceptEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  BOOL Accept;
  INT reserved;
} HTTPServerAcceptEventParams;

#define EID_HTTPSERVER_ACCEPT 1

virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);

class HTTPServerAcceptEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Accept(HTTPServerAcceptEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireAccept(HTTPServerAcceptEventParams *e) {...}

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AuthAttempt Event (HTTPServer Class)

Fires when a connected client makes an authentication attempt.

Syntax

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

typedef struct {
  int64 ConnectionID;
  const char *HTTPMethod;
  const char *URI;
  const char *AuthMethod;
  const char *Username;
  const char *Password;
  int Allow;
  int reserved;
} HTTPServerAuthAttemptEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR HTTPMethod;
  LPCWSTR URI;
  LPCWSTR AuthMethod;
  LPCWSTR Username;
  LPCWSTR Password;
  BOOL Allow;
  INT reserved;
} HTTPServerAuthAttemptEventParams;

#define EID_HTTPSERVER_AUTHATTEMPT 2

virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURI, LPSTR &lpszAuthMethod, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAllow);

class HTTPServerAuthAttemptEventParams {
public:
  qint64 ConnectionID();

  const QString &HTTPMethod();

  const QString &URI();

  const QString &AuthMethod();

  const QString &Username();

  const QString &Password();

  bool Allow();
  void SetAllow(bool bAllow);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthAttempt(HTTPServerAuthAttemptEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireAuthAttempt(HTTPServerAuthAttemptEventParams *e) {...}

Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

Connect Event (HTTPServer Class)

Reports an accepted connection.

Syntax

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

typedef struct {
  int64 ConnectionID;
  const char *RemoteAddress;
  int RemotePort;
  int reserved;
} HTTPServerConnectEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT reserved;
} HTTPServerConnectEventParams;

#define EID_HTTPSERVER_CONNECT 3

virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionID, LPSTR &lpszRemoteAddress, INT &iRemotePort);

class HTTPServerConnectEventParams {
public:
  qint64 ConnectionID();

  const QString &RemoteAddress();

  int RemotePort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connect(HTTPServerConnectEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireConnect(HTTPServerConnectEventParams *e) {...}

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as TLSHandshake or Data.

CustomRequest Event (HTTPServer Class)

Reports a request of a non-standard type (method).

Syntax

ANSI (Cross Platform)
virtual int FireCustomRequest(HTTPServerCustomRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  const char *HTTPMethod;
  int Handled;
  int reserved;
} HTTPServerCustomRequestEventParams;


Unicode (Windows)
virtual INT FireCustomRequest(HTTPServerCustomRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  LPCWSTR HTTPMethod;
  BOOL Handled;
  INT reserved;
} HTTPServerCustomRequestEventParams;

#define EID_HTTPSERVER_CUSTOMREQUEST 4

virtual INT SECUREBLACKBOX_CALL FireCustomRequest(LONG64 &lConnectionID, LPSTR &lpszURI, LPSTR &lpszHTTPMethod, BOOL &bHandled);

class HTTPServerCustomRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  const QString &HTTPMethod();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CustomRequest(HTTPServerCustomRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireCustomRequest(HTTPServerCustomRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a non-standard request received from the client. The HTTPMethod contains the non-standard HTTP method.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Data Event (HTTPServer Class)

Supplies a data chunk received within a POST or PUT upload.

Syntax

ANSI (Cross Platform)
virtual int FireData(HTTPServerDataEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *Buffer;
  int lenBuffer;
  int reserved;
} HTTPServerDataEventParams;


Unicode (Windows)
virtual INT FireData(HTTPServerDataEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCSTR Buffer;
  INT lenBuffer;
  INT reserved;
} HTTPServerDataEventParams;

#define EID_HTTPSERVER_DATA 5

virtual INT SECUREBLACKBOX_CALL FireData(LONG64 &lConnectionID, LPSTR &lpBuffer, INT &lenBuffer);

class HTTPServerDataEventParams {
public:
  qint64 ConnectionID();

  const QByteArray &Buffer();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Data(HTTPServerDataEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireData(HTTPServerDataEventParams *e) {...}

Remarks

This event is fired to supply another piece of data received within a POST or PUT upload operation. This event may fire multiple times during a single request upload to pass the uploaded data to the application chunk-by-chunk.

DeleteRequest Event (HTTPServer Class)

Reports a DELETE request.

Syntax

ANSI (Cross Platform)
virtual int FireDeleteRequest(HTTPServerDeleteRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerDeleteRequestEventParams;


Unicode (Windows)
virtual INT FireDeleteRequest(HTTPServerDeleteRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerDeleteRequestEventParams;

#define EID_HTTPSERVER_DELETEREQUEST 6

virtual INT SECUREBLACKBOX_CALL FireDeleteRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerDeleteRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DeleteRequest(HTTPServerDeleteRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireDeleteRequest(HTTPServerDeleteRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a DELETE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Disconnect Event (HTTPServer Class)

Fires to report a disconnected client.

Syntax

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

typedef struct {
  int64 ConnectionID;
  int reserved;
} HTTPServerDisconnectEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} HTTPServerDisconnectEventParams;

#define EID_HTTPSERVER_DISCONNECT 7

virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);

class HTTPServerDisconnectEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnect(HTTPServerDisconnectEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireDisconnect(HTTPServerDisconnectEventParams *e) {...}

Remarks

The class fires this event when a connected client disconnects.

Error Event (HTTPServer Class)

Information about errors during data delivery.

Syntax

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

typedef struct {
  int64 ConnectionID;
  int ErrorCode;
  int Fatal;
  int Remote;
  const char *Description;
  int reserved;
} HTTPServerErrorEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  INT ErrorCode;
  BOOL Fatal;
  BOOL Remote;
  LPCWSTR Description;
  INT reserved;
} HTTPServerErrorEventParams;

#define EID_HTTPSERVER_ERROR 8

virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);

class HTTPServerErrorEventParams {
public:
  qint64 ConnectionID();

  int ErrorCode();

  bool Fatal();

  bool Remote();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(HTTPServerErrorEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireError(HTTPServerErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (HTTPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

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

typedef struct {
  int64 ConnectionID;
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} HTTPServerExternalSignEventParams;


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

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} HTTPServerExternalSignEventParams;

#define EID_HTTPSERVER_EXTERNALSIGN 9

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

class HTTPServerExternalSignEventParams {
public:
  qint64 ConnectionID();

  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalSign(HTTPServerExternalSignEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireExternalSign(HTTPServerExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

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

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileError Event (HTTPServer Class)

Reports a file access error to the application.

Syntax

ANSI (Cross Platform)
virtual int FireFileError(HTTPServerFileErrorEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *FileName;
  int ErrorCode;
  int reserved;
} HTTPServerFileErrorEventParams;


Unicode (Windows)
virtual INT FireFileError(HTTPServerFileErrorEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR FileName;
  INT ErrorCode;
  INT reserved;
} HTTPServerFileErrorEventParams;

#define EID_HTTPSERVER_FILEERROR 10

virtual INT SECUREBLACKBOX_CALL FireFileError(LONG64 &lConnectionID, LPSTR &lpszFileName, INT &iErrorCode);

class HTTPServerFileErrorEventParams {
public:
  qint64 ConnectionID();

  const QString &FileName();

  int ErrorCode();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileError(HTTPServerFileErrorEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireFileError(HTTPServerFileErrorEventParams *e) {...}

Remarks

The class uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

GetRequest Event (HTTPServer Class)

Reports a GET request.

Syntax

ANSI (Cross Platform)
virtual int FireGetRequest(HTTPServerGetRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerGetRequestEventParams;


Unicode (Windows)
virtual INT FireGetRequest(HTTPServerGetRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerGetRequestEventParams;

#define EID_HTTPSERVER_GETREQUEST 11

virtual INT SECUREBLACKBOX_CALL FireGetRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerGetRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetRequest(HTTPServerGetRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireGetRequest(HTTPServerGetRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a GET request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, SetResponseFile or SetResponseString methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

HeadersPrepared Event (HTTPServer Class)

Fires when the response headers have been formed and are ready to be sent to the server.

Syntax

ANSI (Cross Platform)
virtual int FireHeadersPrepared(HTTPServerHeadersPreparedEventParams *e);

typedef struct {
  int64 ConnectionID;
  int reserved;
} HTTPServerHeadersPreparedEventParams;


Unicode (Windows)
virtual INT FireHeadersPrepared(HTTPServerHeadersPreparedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} HTTPServerHeadersPreparedEventParams;

#define EID_HTTPSERVER_HEADERSPREPARED 12

virtual INT SECUREBLACKBOX_CALL FireHeadersPrepared(LONG64 &lConnectionID);

class HTTPServerHeadersPreparedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void HeadersPrepared(HTTPServerHeadersPreparedEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireHeadersPrepared(HTTPServerHeadersPreparedEventParams *e) {...}

Remarks

The class fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use GetResponseHeader method with an empty header name to get the whole response header.

HeadRequest Event (HTTPServer Class)

Reports a HEAD request.

Syntax

ANSI (Cross Platform)
virtual int FireHeadRequest(HTTPServerHeadRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerHeadRequestEventParams;


Unicode (Windows)
virtual INT FireHeadRequest(HTTPServerHeadRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerHeadRequestEventParams;

#define EID_HTTPSERVER_HEADREQUEST 13

virtual INT SECUREBLACKBOX_CALL FireHeadRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerHeadRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void HeadRequest(HTTPServerHeadRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireHeadRequest(HTTPServerHeadRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a HEAD request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Notification Event (HTTPServer Class)

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

Syntax

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

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


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

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

#define EID_HTTPSERVER_NOTIFICATION 14

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

class HTTPServerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(HTTPServerNotificationEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireNotification(HTTPServerNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

OptionsRequest Event (HTTPServer Class)

Reports an OPTIONS request.

Syntax

ANSI (Cross Platform)
virtual int FireOptionsRequest(HTTPServerOptionsRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerOptionsRequestEventParams;


Unicode (Windows)
virtual INT FireOptionsRequest(HTTPServerOptionsRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerOptionsRequestEventParams;

#define EID_HTTPSERVER_OPTIONSREQUEST 15

virtual INT SECUREBLACKBOX_CALL FireOptionsRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerOptionsRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void OptionsRequest(HTTPServerOptionsRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireOptionsRequest(HTTPServerOptionsRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about an OPTIONS request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

PatchRequest Event (HTTPServer Class)

Reports a PATCH request.

Syntax

ANSI (Cross Platform)
virtual int FirePatchRequest(HTTPServerPatchRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerPatchRequestEventParams;


Unicode (Windows)
virtual INT FirePatchRequest(HTTPServerPatchRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerPatchRequestEventParams;

#define EID_HTTPSERVER_PATCHREQUEST 16

virtual INT SECUREBLACKBOX_CALL FirePatchRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerPatchRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PatchRequest(HTTPServerPatchRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FirePatchRequest(HTTPServerPatchRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a PATCH request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

PostRequest Event (HTTPServer Class)

Reports a POST request.

Syntax

ANSI (Cross Platform)
virtual int FirePostRequest(HTTPServerPostRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerPostRequestEventParams;


Unicode (Windows)
virtual INT FirePostRequest(HTTPServerPostRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerPostRequestEventParams;

#define EID_HTTPSERVER_POSTREQUEST 17

virtual INT SECUREBLACKBOX_CALL FirePostRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerPostRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PostRequest(HTTPServerPostRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FirePostRequest(HTTPServerPostRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a POST request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

PutRequest Event (HTTPServer Class)

Reports a PUT request.

Syntax

ANSI (Cross Platform)
virtual int FirePutRequest(HTTPServerPutRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerPutRequestEventParams;


Unicode (Windows)
virtual INT FirePutRequest(HTTPServerPutRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerPutRequestEventParams;

#define EID_HTTPSERVER_PUTREQUEST 18

virtual INT SECUREBLACKBOX_CALL FirePutRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerPutRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PutRequest(HTTPServerPutRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FirePutRequest(HTTPServerPutRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a PUT request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

ResourceAccess Event (HTTPServer Class)

Reports an attempt to access a resource.

Syntax

ANSI (Cross Platform)
virtual int FireResourceAccess(HTTPServerResourceAccessEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *HTTPMethod;
  const char *URI;
  int Allow;
  char *RedirectURI;
  int reserved;
} HTTPServerResourceAccessEventParams;


Unicode (Windows)
virtual INT FireResourceAccess(HTTPServerResourceAccessEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR HTTPMethod;
  LPCWSTR URI;
  BOOL Allow;
  LPWSTR RedirectURI;
  INT reserved;
} HTTPServerResourceAccessEventParams;

#define EID_HTTPSERVER_RESOURCEACCESS 19

virtual INT SECUREBLACKBOX_CALL FireResourceAccess(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURI, BOOL &bAllow, LPSTR &lpszRedirectURI);

class HTTPServerResourceAccessEventParams {
public:
  qint64 ConnectionID();

  const QString &HTTPMethod();

  const QString &URI();

  bool Allow();
  void SetAllow(bool bAllow);

  const QString &RedirectURI();
  void SetRedirectURI(const QString &qsRedirectURI);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResourceAccess(HTTPServerResourceAccessEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireResourceAccess(HTTPServerResourceAccessEventParams *e) {...}

Remarks

The class fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The class will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The class will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

TLSCertValidate Event (HTTPServer Class)

Fires when a client certificate needs to be validated.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertValidate(HTTPServerTLSCertValidateEventParams *e);

typedef struct {
  int64 ConnectionID;
  int Accept;
  int reserved;
} HTTPServerTLSCertValidateEventParams;


Unicode (Windows)
virtual INT FireTLSCertValidate(HTTPServerTLSCertValidateEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  BOOL Accept;
  INT reserved;
} HTTPServerTLSCertValidateEventParams;

#define EID_HTTPSERVER_TLSCERTVALIDATE 20

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);

class HTTPServerTLSCertValidateEventParams {
public:
  qint64 ConnectionID();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSCertValidate(HTTPServerTLSCertValidateEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTLSCertValidate(HTTPServerTLSCertValidateEventParams *e) {...}

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (HTTPServer Class)

Reports the setup of a TLS session.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(HTTPServerTLSEstablishedEventParams *e);

typedef struct {
  int64 ConnectionID;
  int reserved;
} HTTPServerTLSEstablishedEventParams;


Unicode (Windows)
virtual INT FireTLSEstablished(HTTPServerTLSEstablishedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} HTTPServerTLSEstablishedEventParams;

#define EID_HTTPSERVER_TLSESTABLISHED 21

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);

class HTTPServerTLSEstablishedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSEstablished(HTTPServerTLSEstablishedEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTLSEstablished(HTTPServerTLSEstablishedEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (HTTPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(HTTPServerTLSHandshakeEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *ServerName;
  int Abort;
  int reserved;
} HTTPServerTLSHandshakeEventParams;


Unicode (Windows)
virtual INT FireTLSHandshake(HTTPServerTLSHandshakeEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR ServerName;
  BOOL Abort;
  INT reserved;
} HTTPServerTLSHandshakeEventParams;

#define EID_HTTPSERVER_TLSHANDSHAKE 22

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);

class HTTPServerTLSHandshakeEventParams {
public:
  qint64 ConnectionID();

  const QString &ServerName();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSHandshake(HTTPServerTLSHandshakeEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTLSHandshake(HTTPServerTLSHandshakeEventParams *e) {...}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (HTTPServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

ANSI (Cross Platform)
virtual int FireTLSPSK(HTTPServerTLSPSKEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *Identity;
  char *PSK;
  char *Ciphersuite;
  int reserved;
} HTTPServerTLSPSKEventParams;


Unicode (Windows)
virtual INT FireTLSPSK(HTTPServerTLSPSKEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR Identity;
  LPWSTR PSK;
  LPWSTR Ciphersuite;
  INT reserved;
} HTTPServerTLSPSKEventParams;

#define EID_HTTPSERVER_TLSPSK 23

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);

class HTTPServerTLSPSKEventParams {
public:
  qint64 ConnectionID();

  const QString &Identity();

  const QString &PSK();
  void SetPSK(const QString &qsPSK);

  const QString &Ciphersuite();
  void SetCiphersuite(const QString &qsCiphersuite);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSPSK(HTTPServerTLSPSKEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTLSPSK(HTTPServerTLSPSKEventParams *e) {...}

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (HTTPServer Class)

Reports closure of a TLS session.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(HTTPServerTLSShutdownEventParams *e);

typedef struct {
  int64 ConnectionID;
  int reserved;
} HTTPServerTLSShutdownEventParams;


Unicode (Windows)
virtual INT FireTLSShutdown(HTTPServerTLSShutdownEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} HTTPServerTLSShutdownEventParams;

#define EID_HTTPSERVER_TLSSHUTDOWN 24

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);

class HTTPServerTLSShutdownEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSShutdown(HTTPServerTLSShutdownEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTLSShutdown(HTTPServerTLSShutdownEventParams *e) {...}

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TraceRequest Event (HTTPServer Class)

Reports a TRACE request.

Syntax

ANSI (Cross Platform)
virtual int FireTraceRequest(HTTPServerTraceRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *URI;
  int Handled;
  int reserved;
} HTTPServerTraceRequestEventParams;


Unicode (Windows)
virtual INT FireTraceRequest(HTTPServerTraceRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR URI;
  BOOL Handled;
  INT reserved;
} HTTPServerTraceRequestEventParams;

#define EID_HTTPSERVER_TRACEREQUEST 25

virtual INT SECUREBLACKBOX_CALL FireTraceRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);

class HTTPServerTraceRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &URI();

  bool Handled();
  void SetHandled(bool bHandled);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TraceRequest(HTTPServerTraceRequestEventParams *e);

// Or, subclass HTTPServer and override this emitter function.
virtual int FireTraceRequest(HTTPServerTraceRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about a TRACE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw certificate data in DER format.

CA
int
Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)
Default Value:

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
int (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

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

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64
Default Value: 0

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

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

HashAlgorithm
char*
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
char*
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

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

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int
Default Value: 0

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:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
int (read-only)
Default Value: FALSE

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
char*
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int
Default Value: FALSE

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
int (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*
Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)
Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)
Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)
Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)
Default Value:

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
int (read-only)
Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int
Default Value: 0

Returns a simplified qualified status of the certificate.

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

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)
Default Value: FALSE

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

SerialNumber
char*
Default Value:

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
int (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
char*
Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*
Default Value:

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
int (read-only)
Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*
Default Value: ""

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

ValidTo
char*
Default Value: ""

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

Constructors

Certificate()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

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

The following fields are available:

AsyncDocumentID

CustomParams

Data

ExternalHashCalculation

Fields

AsyncDocumentID
char*
Default Value: ""

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

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

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

CustomParams
char*
Default Value: ""

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

Data
char*
Default Value: ""

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

ExternalHashCalculation
int
Default Value: FALSE

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

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

HashAlgorithm
char*
Default Value: "SHA256"

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

KeyID
char*
Default Value: ""

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

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

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

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

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
char*
Default Value: ""

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

Read more about configuring authentication in the KeyID topic.

Method
int
Default Value: 0

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
int
Default Value: 0

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

PublicKeyAlgorithm
char*
Default Value: ""

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


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int
Default Value: 0

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

DNSPort
int
Default Value: 0

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

DNSQueryTimeout
int
Default Value: 0

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

DNSServers
char*
Default Value: ""

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

DNSTotalTimeout
int
Default Value: 0

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

IncomingSpeedLimit
int
Default Value: 0

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

LocalAddress
char*
Default Value: ""

The local network interface to bind the socket to.

LocalPort
int
Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int
Default Value: 0

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

Timeout
int
Default Value: 60000

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

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

UseIPv6
int
Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

TLSConnectionInfo Type

Contains information about a network connection.

Syntax

SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

The following fields are available:

Fields

AEADCipher
int (read-only)
Default Value: FALSE

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
int (read-only)
Default Value: 0

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

ChainValidationResult
int (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

The cipher suite employed by this connection.

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

ClientAuthenticated
int (read-only)
Default Value: FALSE

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
int (read-only)
Default Value: FALSE

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
int (read-only)
Default Value: FALSE

Indicates whether the connection has been established fully.

ConnectionID
char* (read-only)
Default Value:

The unique identifier assigned to this connection.

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

The digest algorithm used in a TLS-enabled connection.

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

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

Exportable
int (read-only)
Default Value: FALSE

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

ID
int64 (read-only)
Default Value: -1

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

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

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

KeyExchangeKeyBits
int (read-only)
Default Value: 0

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

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

The elliptic curve used in this connection.

PFSCipher
int (read-only)
Default Value: FALSE

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

PreSharedIdentity
char*
Default Value: ""

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

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

A hint professed by the server to help the client select the PSK identity to use.

PublicKeyBits
int (read-only)
Default Value: 0

The length of the public key.

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

The client's IP address.

RemotePort
int (read-only)
Default Value: 0

The remote port of the client connection.

ResumedSession
int (read-only)
Default Value: FALSE

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

SecureConnection
int (read-only)
Default Value: FALSE

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
int (read-only)
Default Value: FALSE

Indicates whether server authentication was performed during a TLS-enabled connection.

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

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
int (read-only)
Default Value: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
int (read-only)
Default Value: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
int64 (read-only)
Default Value: 0

The total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)
Default Value: 0

The total number of bytes sent over this connection.

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

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

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

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

Constructors

TLSConnectionInfo()

Creates a new TLSConnectionInfo object.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

AutoValidateCertificates

ForceResumeIfDestinationChanges

PreSharedIdentity

PreSharedKey

PreSharedKeyCiphersuite

RenegotiationAttackPreventionMode

RevocationCheck

SSLOptions

TLSMode

UseExtendedMasterSecret

UseSessionResumption

Versions

Fields

AutoValidateCertificates
int
Default Value: TRUE

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

BaseConfiguration
int
Default Value: 0

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


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Ciphersuites
char*
Default Value: ""

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, allowing all ciphersuites to be blanketly enabled or disabled 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

ClientAuth
int
Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

ECCurves
char*
Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*
Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int
Default Value: FALSE

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

PreSharedIdentity
char*
Default Value: ""

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

PreSharedKey
char*
Default Value: ""

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

PreSharedKeyCiphersuite
char*
Default Value: ""

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

RenegotiationAttackPreventionMode
int
Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
int
Default Value: 1

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.


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

SSLOptions
int
Default Value: 16

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. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

TLSMode
int
Default Value: 0

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
int
Default Value: FALSE

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

UseSessionResumption
int
Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int
Default Value: 16

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

Constructors

TLSSettings()

Creates a new TLSSettings object.

UserAccount Type

A container for user account information.

Syntax

SecureBlackboxUserAccount (declared in secureblackbox.h)

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

The following fields are available:

Fields

AssociatedData
char*
Default Value:

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

BasePath
char*
Default Value: ""

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

Certificate
char*
Default Value:

Contains the user's certificate.

Data
char*
Default Value: ""

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

Email
char*
Default Value: ""

The user's email address.

Handle
int64
Default Value: 0

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

HashAlgorithm
char*
Default Value: ""

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:


SB_MAC_ALGORITHM_HMAC_SHA1	`SHA1`
SB_MAC_ALGORITHM_HMAC_SHA256	`SHA256`
SB_MAC_ALGORITHM_HMAC_SHA512	`SHA512`

IncomingSpeedLimit
int
Default Value: 0

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

OtpAlgorithm
int
Default Value: 0

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.


oaHmac	`0`
oaTime	`1`

OTPLen
int
Default Value: 0

Specifies the length of the user's OTP password.

OtpValue
int
Default Value: 0

The user's time interval (TOTP) or Counter (HOTP).

OutgoingSpeedLimit
int
Default Value: 0

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

Password
char*
Default Value: ""

The user's authentication password.

SharedSecret
char*
Default Value:

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

SSHKey
char*
Default Value:

Contains the user's SSH key.

Username
char*
Default Value: ""

The registered name (login) of the user.

Constructors

UserAccount()

Creates a new UserAccount object

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the HTTPServer class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

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

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

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (HTTPServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

HTTPServer Config Settings

AllowKeepAlive: Enables or disables keep-alive mode.

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.

AllowOptionsResponseWithoutAuth: Enables unauthenticated responses to OPTIONS requests.

Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client.

AuthBasic: Turns on/off the basic authentication.

When switched on, connecting clients can use the basic authentication.

AuthDigest: Turns on/off the digest authentication.

When switched on, connecting clients can use the digest authentication.

AuthDigestExpire: Specifies digest expiration time for digest authentication.

Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20.

AuthRealm: Specifies authentication realm for digest and NTLM authentication.

Specifies authentication realm for digest and NTLM authentication types.

BoundAddress: Returns the bound address of the listening socket.

Use this property to obtain the bound address of the listening socket.

BoundPort: The port that was bound by the server.

Returns the port number that was bound by the server.

CompressionLevel: The default compression level to use.

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.

DocumentRoot: The document root of the server.

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

DualStack: Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

HandshakeTimeout: The HTTPS handshake timeout.

The HTTPS handshake timeout in milliseconds.

HomePage: Specifies the home page resource name.

Use this property to specify the home page (/) resource name.

Host: The host to bind to.

Specifies a specific interface the server should listen on.

Port: The port to listen on.

This config setting mimics the Port property. Please use that instead.

PortRangeFrom: The lower bound of allowed port scope to listen on.

Specifies the lowest port number the server may use if dynamic allocation is used.

PortRangeTo: The higher bound of allowed port scope to listen on.

Specifies the highest port number the server may use if dynamic allocation is used.

PreSharedIdentityHint: Gets or sets the PSK identity hint.

Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake.

RequestFilter: The request string modifier.

Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request.

SessionTimeout: The HTTP session timeout.

The HTTP session timeout in milliseconds.

SleepLen: Adjusts the server loop idling time.

Use this property to adjust the server connection loop idling time between consecutive connection read calls. Increasing this setting may help combat excessive CPU usage in performance-restricted or busy environments. Setting it to zero removes the idling altogether, which maximizes the throughput but may cause excessive CPU load.

TempDir: A temporary directory to use.

Specifies the temporary directory to use during server operation.

TempPath: Path for storing temporary files.

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

TLSExtensions: TBD.

TBD

TLSPeerExtensions: TBD.

TBD

TLSServerCertIndex: Specifies the index of the server certificate to use.

This setting allows your code to specify the exact certificate/chain to use for the TLS handshake that has just commenced, if your server is configured with more than one chain. This property should typically be adjusted from within the OnTLSHandshake event handler.

Note: the server component normally picks up the most appropriate certificate automatically. This setting is a wiretap for scenarios where unusual or cherry-picked certificate selection logic may be necessary.

UseChunkedTransfer: Enables chunked transfer.

Use this property to enable chunked content encoding.

UseCompression: Enables or disables server-side compression.

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

WebsiteName: The website name for the TLS certificate.

Assign this property with a name to put in a self-generated TLS certificate.

Base Config Settings

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

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

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

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

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

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

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

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

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

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix: The suffix to assign for TLD names.

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

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

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

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

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

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

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

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

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

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

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

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

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

ListDelimiter: The delimiter character for multi-element lists.

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

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

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

ProductVersion: Returns the version of the SecureBlackbox library.

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

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

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

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


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

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

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

UseLegacyAdESValidation: Enables legacy AdES validation mode.

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

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

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

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

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

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

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

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

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

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

Trappable Errors (HTTPServer Class)

Error Handling (C++)

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

HTTPServer Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
19922945	Unsupported keep-alive policy (`SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY`)
19922946	Wrong request filter string format (`SB_ERROR_HTTP_WRONG_REQUEST_FILTER_FORMAT`)