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.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.TLSServerChain.Add(mgr.Certificate); // The CA certificate: this is to help connecting clients validate the chain. mgr.ImportFromFile("CertCA.cer", ""); server.TLSServerChain.Add(mgr.Certificate); // *** Adjusting finer-grained TLS settings *** // - session resumption (allows for faster handshakes for connections from the same origin) server.TLSSettings.UseSessionResumption = true; // - secure configuration server.TLSSettings.BaseConfiguration = stpcHighlySecure; // - disabling a cipher suite we dislike (just because we can): server.TLSSettings.Ciphersuites = "-DHE_RSA_AES128_SHA" // *** Configuring versions *** // The default version setting at the time of writing (May 2021) is TLS 1.2 and TLS 1.3, // but that may change in future versions. The following tune-up additionally activates TLS 1.1 and TLS 1.0, // which weakens security, but may be necessary to accept connections from older clients: server.TLSSettings.Versions = csbTLS1 | csbTLS11 | csbTLS12 | csbTLS13;

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

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

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

HTTPServer and SSLLabs

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

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

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

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int secureblackbox_httpserver_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

AllowCustomRequests Property (HTTPServer Class)

Allows custom requests.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

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

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

AuthRealm Property (HTTPServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_httpserver_getauthrealm(void* lpObj);
int secureblackbox_httpserver_setauthrealm(void* lpObj, const char* lpszAuthRealm);

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

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

AuthTypes Property (HTTPServer Class)

Defines allowed HTTP authentication types.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

0

Remarks

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

Data Type

Integer

BoundPort Property (HTTPServer Class)

Indicates the bound listening port.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();

int secureblackbox_httpserver_getboundport(void* lpObj);

int GetBoundPort();

Default Value

0

Remarks

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

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

Data Type

Integer

CompressionLevel Property (HTTPServer Class)

The default compression level to use.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

6

Remarks

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

Data Type

Integer

DocumentRoot Property (HTTPServer Class)

The document root of the server.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_httpserver_getdocumentroot(void* lpObj);
int secureblackbox_httpserver_setdocumentroot(void* lpObj, const char* lpszDocumentRoot);

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

Default Value

""

Remarks

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

Data Type

String

ExternalCrypto Property (HTTPServer Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

int secureblackbox_httpserver_getfipsmode(void* lpObj);
int secureblackbox_httpserver_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (HTTPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (HTTPServer Class)

The host to bind the listening port to.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_httpserver_gethost(void* lpObj);
int secureblackbox_httpserver_sethost(void* lpObj, const char* lpszHost);

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

Default Value

""

Remarks

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

Data Type

String

PinnedClient Property (HTTPServer Class)

Populates the pinned client details.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

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

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

Default Value

80

Remarks

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

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

Data Type

Integer

PortRangeFrom Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

0

Remarks

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

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

Data Type

Integer

PortRangeTo Property (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

0

Remarks

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

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

Data Type

Integer

SessionTimeout Property (HTTPServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

360000

Remarks

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

Data Type

Integer

SocketSettings Property (HTTPServer Class)

Manages network connection settings.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

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

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

Default Value

FALSE

Remarks

Use this property to enable chunked content encoding.

Data Type

Boolean

UseCompression Property (HTTPServer Class)

Enables or disables server-side compression.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

Users Property (HTTPServer Class)

Provides a list of registered users.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

Common ActionIDs:

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.

DropClient Method (HTTPServer Class)

Terminates a client connection.

Syntax

• C++
• C
• Qt

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

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

GetRequestBytes Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

• C++
• C
• Qt

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:

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

• C++
• C
• Qt

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

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.

GetRequestStream Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

• C++
• C
• Qt

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:

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

GetRequestString Method (HTTPServer Class)

Returns the contents of the client's HTTP request.

Syntax

• C++
• C
• Qt

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.

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:

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.

GetRequestUsername Method (HTTPServer Class)

Returns the username for a connection.

Syntax

• C++
• C
• Qt

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

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.

GetResponseHeader Method (HTTPServer Class)

Returns a response header value.

Syntax

• C++
• C
• Qt

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

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.

ListClients Method (HTTPServer Class)

Enumerates the connected clients.

Syntax

• C++
• C
• Qt

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

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.

PinClient Method (HTTPServer Class)

Takes a snapshot of the connection's properties.

Syntax

• C++
• C
• Qt

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

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

ProcessGenericRequest Method (HTTPServer Class)

Processes a generic HTTP request.

Syntax

• C++
• C
• Qt

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

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.

ProcessGenericRequestStream Method (HTTPServer Class)

Processes a generic HTTP request from a stream.

Syntax

• C++
• C
• Qt

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

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

Reset Method (HTTPServer Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

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

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

SetResponseBytes Method (HTTPServer Class)

Sets a byte array to be served as a response.

Syntax

• C++
• C
• Qt

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:

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

SetResponseFile Method (HTTPServer Class)

Sets a file to be served as a response.

Syntax

• C++
• C
• Qt

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:

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

SetResponseHeader Method (HTTPServer Class)

Sets a response header.

Syntax

• C++
• C
• Qt

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

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

SetResponseStatus Method (HTTPServer Class)

Sets an HTTP status to be sent with the response.

Syntax

• C++
• C
• Qt

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

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

SetResponseStream Method (HTTPServer Class)

Sets a stream to be served as a response.

Syntax

• C++
• C
• Qt

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:

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

SetResponseString Method (HTTPServer Class)

Sets a string to be served as a response.

Syntax

• C++
• C
• Qt

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:

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

Start Method (HTTPServer Class)

Starts the server.

Syntax

• C++
• C
• Qt

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

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

Stop Method (HTTPServer Class)

Stops the server.

Syntax

• C++
• C
• Qt

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

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

Accept Event (HTTPServer Class)

Reports an incoming connection.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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.

Disconnect Event (HTTPServer Class)

Fires to report a disconnected client.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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.

Notification Event (HTTPServer Class)

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

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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.

PatchRequest Event (HTTPServer Class)

Reports a PATCH request.

Syntax

• C++
• C
• Qt

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.

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.

PostRequest Event (HTTPServer Class)

Reports a POST request.

Syntax

• C++
• C
• Qt

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.

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.

PutRequest Event (HTTPServer Class)

Reports a PUT request.

Syntax

• C++
• C
• Qt

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.

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.

ResourceAccess Event (HTTPServer Class)

Reports an attempt to access a resource.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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.

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.

Fields

Constructors

Certificate()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

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

Fields