HTTPClient Class
Properties Methods Events Config Settings Errors
The HTTPClient class implements client-side functionality of HTTP and HTTPS protocols.
Syntax
HTTPClient
Remarks
HTTPClient provides means of exchanging HTTP messages with HTTP servers. Both plain (HTTP) and secure (HTTPS) connection types are supported.
Features supported
- All standard request types (GET, POST, PUT etc.), plus custom VERBs
- TLS 1.2 and 1.3 (and earlier versions for older servers)
- Strong client and server authentication on TLS and HTTP levels
- Flexible custom header adjustment
- A variety of proxy server types
Configuring the component
HTTPClient is very easy to configure. In some cases, like in the example given
below, you do not need any special tuneups whatsoever:
client.Get("http://www.mywebserver.com/");
if (client.StatusCode == 200) {
string response = client.OutputString;
}
You may need to adjust the component settings if you plan to connect to endpoints
secured with TLS. By default, HTTPClient relies on the system settings when
validating server certificates. If you would prefer to ignore the system trust
and implement customized chain validation procedures - such as certificate pinning -
in your code instead, set TLSSettings.AutoValidateCertificates to false, and
subscribe to CertificateValidate event. This event will fire whenever a server
certificate validation needs to be performed.
Use TLSClientChain collection to provide your certificates for client authentication. Make sure the provided certificate contains a private key; otherwise it will be unable to authenticate.
To provide custom HTTP headers, subscribe to HeadersPrepared event. HTTPClient fires this event right before sending the request out to the server, giving you an opportunity to alter the headers or add your own. The list of headers can be accessed via the RequestHeaders collection. Note: the headers can only be modified from the HeadersPrepared event handler. Setting them earlier or later in your code won't provide the expected effect.
Having set up the component, use the appropriate output property (such as OutputFile) to obtain the response in the desired format (string, memory buffer, or file).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AuthTypes | Defines allowed HTTP authentication types. |
BlockedCertificates | The certificates that must be rejected as trust anchors. |
ConnectionInfo | Returns the details of the underlying network connection. |
CustomRequest | Specifies a custom request verb. |
DynamicData | Takes a piece of data to be sent to the server within a dynamic POST or PUT request. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
KeepAlivePolicy | Defines the keep-alive handling policy. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
OutputBytes | Contains the response content. |
OutputFile | A path to the output file. |
OutputString | Contains the response content. |
Proxy | The proxy server settings. |
ReasonPhrase | Contains the Reason Phrase element of the server's response. |
RequestHeaders | Contains HTTP request headers. |
RequestParameters | Provides access to common HTTP request properties. |
ResponseHeaders | Contains the HTTP server's response headers. |
ResponseParameters | Contains the HTTP server's response parameters. |
SocketSettings | Manages network connection settings. |
StatusCode | Contains the Status Code element of the server's response. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Delete | Sends a DELETE request to the server. |
DoAction | Performs an additional action. |
Get | Sends a GET request to the server. |
Head | Sends a HEAD request to the server. |
Options | Sends an OPTIONS request to the server. |
Post | Sends a POST request to the server. |
PostBytes | Sends a POST request to the server. |
PostFile | Sends a file to the server using a POST request. |
PostStream | Sends a POST request to the server. |
PostWebForm | Posts a web form data to the server. |
Put | Sends a PUT request to the server. |
PutBytes | Sends a PUT request to the server. |
PutFile | Sends a file to the server using a PUT request. |
PutStream | Sends a PUT request to the server. |
Reset | Resets the class settings. |
Trace | Sends a TRACE request to the server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Cookie | Fired to report a received cookie. |
DocumentBegin | Marks the start of the incoming HTML document or file. |
DocumentEnd | Marks the successful receipt of the incoming HTML document or file. |
DynamicDataNeeded | Requests a portion of data to be uploaded from the application. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
HeadersPrepared | Fires when the request headers have been formed and are about to be sent to the server. |
HeadersReceived | Fires when the HTTP response headers have just been received from the server. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Fires periodically during the data transfer. |
Redirection | Fires when the server suggests a redirect. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSPSK | Notifies the application about the PSK key exchange. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AuthStickToLastURL | TBD. |
CacheStreamOutput | Tells the class whether to cache stream- and file-bound responses in the class. |
Cookies | TBD. |
DefClientCookieFmt | TBD. |
ForceNTLMAuth | Activates and enforces NTLM authentication. |
IgnoreCookieSecureFlag | TBD. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
IgnoreUnknownTransferEncodings | All incoming responses with unknown transfer encodings are ignored if this property is true. |
KeepConnectionOpen | TBD. |
MaxRedirections | The maximum number of HTTP redirects. |
OutputFile | Specifies the file where the received content should be saved to. |
PersistentAuthHeader | Whether to resend NTLM negotiation on every request. |
RequestCompressionGZip | Ask server to use GZip compression. |
RequestCompressionLevel | Ask server to use the specified compression level. |
SendBufferSize | Size of send buffer in bytes. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
SuppressRedirectionContent | Whether to suppress the redirection content. |
TempPath | Path for storing temporary files. |
TLSExtensions | TBD. |
TLSPeerExtensions | TBD. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
Use100Continue | Whether to use 100-continue for POST and PUT commands. |
UseCompression | Whether to use GZip compression. |
UseKerberosAuth | TBD. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
AuthTypes Property (HTTPClient Class)
Defines allowed HTTP authentication types.
Syntax
ANSI (Cross Platform) int GetAuthTypes();
int SetAuthTypes(int iAuthTypes); Unicode (Windows) INT GetAuthTypes();
INT SetAuthTypes(INT iAuthTypes);
int secureblackbox_httpclient_getauthtypes(void* lpObj);
int secureblackbox_httpclient_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:
haBasic | 0x01 | Basic authentication |
haDigest | 0x02 | Digest authentication (RFC 2617) |
haNTLM | 0x04 | Windows NTLM authentication |
haKerberos | 0x08 | Kerberos (Negotiate) authentication |
haOAuth2 | 0x10 | OAuth2 authentication |
Data Type
Integer
BlockedCertificates Property (HTTPClient Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_httpclient_getblockedcertcount(void* lpObj);
int secureblackbox_httpclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_httpclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_httpclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_httpclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Remarks
Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.
This property is not available at design time.
Data Type
ConnectionInfo Property (HTTPClient Class)
Returns the details of the underlying network connection.
Syntax
SecureBlackboxTLSConnectionInfo* GetConnectionInfo();
int secureblackbox_httpclient_getconninfoaeadcipher(void* lpObj);
int secureblackbox_httpclient_getconninfochainvalidationdetails(void* lpObj);
int secureblackbox_httpclient_getconninfochainvalidationresult(void* lpObj);
char* secureblackbox_httpclient_getconninfociphersuite(void* lpObj);
int secureblackbox_httpclient_getconninfoclientauthenticated(void* lpObj);
int secureblackbox_httpclient_getconninfoclientauthrequested(void* lpObj);
int secureblackbox_httpclient_getconninfoconnectionestablished(void* lpObj);
int secureblackbox_httpclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);
char* secureblackbox_httpclient_getconninfodigestalgorithm(void* lpObj);
char* secureblackbox_httpclient_getconninfoencryptionalgorithm(void* lpObj);
int secureblackbox_httpclient_getconninfoexportable(void* lpObj);
int64 secureblackbox_httpclient_getconninfoid(void* lpObj);
char* secureblackbox_httpclient_getconninfokeyexchangealgorithm(void* lpObj);
int secureblackbox_httpclient_getconninfokeyexchangekeybits(void* lpObj);
char* secureblackbox_httpclient_getconninfonamedeccurve(void* lpObj);
int secureblackbox_httpclient_getconninfopfscipher(void* lpObj);
char* secureblackbox_httpclient_getconninfopresharedidentity(void* lpObj);
char* secureblackbox_httpclient_getconninfopresharedidentityhint(void* lpObj);
int secureblackbox_httpclient_getconninfopublickeybits(void* lpObj);
char* secureblackbox_httpclient_getconninforemoteaddress(void* lpObj);
int secureblackbox_httpclient_getconninforemoteport(void* lpObj);
int secureblackbox_httpclient_getconninforesumedsession(void* lpObj);
int secureblackbox_httpclient_getconninfosecureconnection(void* lpObj);
int secureblackbox_httpclient_getconninfoserverauthenticated(void* lpObj);
char* secureblackbox_httpclient_getconninfosignaturealgorithm(void* lpObj);
int secureblackbox_httpclient_getconninfosymmetricblocksize(void* lpObj);
int secureblackbox_httpclient_getconninfosymmetrickeybits(void* lpObj);
int64 secureblackbox_httpclient_getconninfototalbytesreceived(void* lpObj);
int64 secureblackbox_httpclient_getconninfototalbytessent(void* lpObj);
char* secureblackbox_httpclient_getconninfovalidationlog(void* lpObj);
char* secureblackbox_httpclient_getconninfoversion(void* lpObj);
bool GetConnInfoAEADCipher(); int GetConnInfoChainValidationDetails(); int GetConnInfoChainValidationResult(); QString GetConnInfoCiphersuite(); bool GetConnInfoClientAuthenticated(); bool GetConnInfoClientAuthRequested(); bool GetConnInfoConnectionEstablished(); QByteArray GetConnInfoConnectionID(); QString GetConnInfoDigestAlgorithm(); QString GetConnInfoEncryptionAlgorithm(); bool GetConnInfoExportable(); qint64 GetConnInfoID(); QString GetConnInfoKeyExchangeAlgorithm(); int GetConnInfoKeyExchangeKeyBits(); QString GetConnInfoNamedECCurve(); bool GetConnInfoPFSCipher(); QString GetConnInfoPreSharedIdentity(); QString GetConnInfoPreSharedIdentityHint(); int GetConnInfoPublicKeyBits(); QString GetConnInfoRemoteAddress(); int GetConnInfoRemotePort(); bool GetConnInfoResumedSession(); bool GetConnInfoSecureConnection(); bool GetConnInfoServerAuthenticated(); QString GetConnInfoSignatureAlgorithm(); int GetConnInfoSymmetricBlockSize(); int GetConnInfoSymmetricKeyBits(); qint64 GetConnInfoTotalBytesReceived(); qint64 GetConnInfoTotalBytesSent(); QString GetConnInfoValidationLog(); QString GetConnInfoVersion();
Remarks
Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.
This property is read-only and not available at design time.
Data Type
SecureBlackboxTLSConnectionInfo
CustomRequest Property (HTTPClient Class)
Specifies a custom request verb.
Syntax
ANSI (Cross Platform) char* GetCustomRequest();
int SetCustomRequest(const char* lpszCustomRequest); Unicode (Windows) LPWSTR GetCustomRequest();
INT SetCustomRequest(LPCWSTR lpszCustomRequest);
char* secureblackbox_httpclient_getcustomrequest(void* lpObj);
int secureblackbox_httpclient_setcustomrequest(void* lpObj, const char* lpszCustomRequest);
QString GetCustomRequest();
int SetCustomRequest(QString qsCustomRequest);
Default Value
""
Remarks
Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.
This property is not available at design time.
Data Type
String
DynamicData Property (HTTPClient Class)
Takes a piece of data to be sent to the server within a dynamic POST or PUT request.
Syntax
ANSI (Cross Platform) int GetDynamicData(char* &lpDynamicData, int &lenDynamicData);
int SetDynamicData(const char* lpDynamicData, int lenDynamicData); Unicode (Windows) INT GetDynamicData(LPSTR &lpDynamicData, INT &lenDynamicData);
INT SetDynamicData(LPCSTR lpDynamicData, INT lenDynamicData);
int secureblackbox_httpclient_getdynamicdata(void* lpObj, char** lpDynamicData, int* lenDynamicData);
int secureblackbox_httpclient_setdynamicdata(void* lpObj, const char* lpDynamicData, int lenDynamicData);
QByteArray GetDynamicData();
int SetDynamicData(QByteArray qbaDynamicData);
Remarks
Assign the next chunk of data to this property from your DynamicDataNeeded event handler to pass it to the server. Leave it empty to tell the component that no more data is available.
This property is not available at design time.
Data Type
Byte Array
ExternalCrypto Property (HTTPClient Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_httpclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_httpclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_httpclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_httpclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_httpclient_getexternalcryptodata(void* lpObj);
int secureblackbox_httpclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_httpclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_httpclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_httpclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_httpclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_httpclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_httpclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_httpclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_httpclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_httpclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_httpclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_httpclient_getexternalcryptomode(void* lpObj);
int secureblackbox_httpclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_httpclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_httpclient_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
FIPSMode Property (HTTPClient Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_httpclient_getfipsmode(void* lpObj);
int secureblackbox_httpclient_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
KeepAlivePolicy Property (HTTPClient Class)
Defines the keep-alive handling policy.
Syntax
ANSI (Cross Platform) int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy); Unicode (Windows) INT GetKeepAlivePolicy();
INT SetKeepAlivePolicy(INT iKeepAlivePolicy);
Possible Values
CKAP_STANDARD_DEFINED(0),
CKAP_PREFER_KEEP_ALIVE(1),
CKAP_RELY_ON_SERVER(2),
CKAP_KEEP_ALIVES_DISABLED(3)
int secureblackbox_httpclient_getkeepalivepolicy(void* lpObj);
int secureblackbox_httpclient_setkeepalivepolicy(void* lpObj, int iKeepAlivePolicy);
int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy);
Default Value
0
Remarks
Use this property to tune-up the keep-alive mechanism as per the needs of your application.
ckapStandardDefined | 0 | Follow the standard |
ckapPreferKeepAlive | 1 | Always request a keep-alive connection |
ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode |
ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header |
Data Type
Integer
KnownCertificates Property (HTTPClient Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_httpclient_getknowncertcount(void* lpObj);
int secureblackbox_httpclient_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_httpclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_httpclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_httpclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Data Type
KnownCRLs Property (HTTPClient Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_httpclient_getknowncrlcount(void* lpObj);
int secureblackbox_httpclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_httpclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_httpclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_httpclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Remarks
Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.
This property is not available at design time.
Data Type
KnownOCSPs Property (HTTPClient Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_httpclient_getknownocspcount(void* lpObj);
int secureblackbox_httpclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_httpclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_httpclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_httpclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Remarks
Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.
This property is not available at design time.
Data Type
OutputBytes Property (HTTPClient Class)
Contains the response content.
Syntax
ANSI (Cross Platform) int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes); Unicode (Windows) INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_httpclient_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);
QByteArray GetOutputBytes();
Remarks
Use this property to access the content received from the server in response to a prior request.
This property is read-only and not available at design time.
Data Type
Byte Array
OutputFile Property (HTTPClient Class)
A path to the output file.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_httpclient_getoutputfile(void* lpObj);
int secureblackbox_httpclient_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Use this property to specify the file to store the content received from the server in response to a prior request.
Data Type
String
OutputString Property (HTTPClient Class)
Contains the response content.
Syntax
ANSI (Cross Platform) char* GetOutputString(); Unicode (Windows) LPWSTR GetOutputString();
char* secureblackbox_httpclient_getoutputstring(void* lpObj);
QString GetOutputString();
Default Value
""
Remarks
Use this property to access the content received from the server in response to a prior request, as a string.
This property is read-only and not available at design time.
Data Type
String
Proxy Property (HTTPClient Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_httpclient_getproxyaddress(void* lpObj);
int secureblackbox_httpclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_httpclient_getproxyauthentication(void* lpObj);
int secureblackbox_httpclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_httpclient_getproxypassword(void* lpObj);
int secureblackbox_httpclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_httpclient_getproxyport(void* lpObj);
int secureblackbox_httpclient_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_httpclient_getproxyproxytype(void* lpObj);
int secureblackbox_httpclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_httpclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_httpclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_httpclient_getproxyresponsebody(void* lpObj);
int secureblackbox_httpclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_httpclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_httpclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_httpclient_getproxyuseipv6(void* lpObj);
int secureblackbox_httpclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_httpclient_getproxyusername(void* lpObj);
int secureblackbox_httpclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Data Type
ReasonPhrase Property (HTTPClient Class)
Contains the Reason Phrase element of the server's response.
Syntax
ANSI (Cross Platform) char* GetReasonPhrase(); Unicode (Windows) LPWSTR GetReasonPhrase();
char* secureblackbox_httpclient_getreasonphrase(void* lpObj);
QString GetReasonPhrase();
Default Value
""
Remarks
Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).
This property is read-only and not available at design time.
Data Type
String
RequestHeaders Property (HTTPClient Class)
Contains HTTP request headers.
Syntax
SecureBlackboxList<SecureBlackboxStringNameValuePair>* GetRequestHeaders();
int secureblackbox_httpclient_getreqheadercount(void* lpObj);
int secureblackbox_httpclient_setreqheadercount(void* lpObj, int iReqHeaderCount);
char* secureblackbox_httpclient_getreqheadercategory(void* lpObj, int reqheaderindex);
int secureblackbox_httpclient_setreqheadercategory(void* lpObj, int reqheaderindex, const char* lpszReqHeaderCategory);
int secureblackbox_httpclient_getreqheaderformat(void* lpObj, int reqheaderindex);
int secureblackbox_httpclient_setreqheaderformat(void* lpObj, int reqheaderindex, int iReqHeaderFormat);
char* secureblackbox_httpclient_getreqheadername(void* lpObj, int reqheaderindex);
int secureblackbox_httpclient_setreqheadername(void* lpObj, int reqheaderindex, const char* lpszReqHeaderName);
char* secureblackbox_httpclient_getreqheadervalue(void* lpObj, int reqheaderindex);
int secureblackbox_httpclient_setreqheadervalue(void* lpObj, int reqheaderindex, const char* lpszReqHeaderValue);
int GetReqHeaderCount();
int SetReqHeaderCount(int iReqHeaderCount); QString GetReqHeaderCategory(int iReqHeaderIndex);
int SetReqHeaderCategory(int iReqHeaderIndex, QString qsReqHeaderCategory); int GetReqHeaderFormat(int iReqHeaderIndex);
int SetReqHeaderFormat(int iReqHeaderIndex, int iReqHeaderFormat); QString GetReqHeaderName(int iReqHeaderIndex);
int SetReqHeaderName(int iReqHeaderIndex, QString qsReqHeaderName); QString GetReqHeaderValue(int iReqHeaderIndex);
int SetReqHeaderValue(int iReqHeaderIndex, QString qsReqHeaderValue);
Remarks
Use this property to check and/or adjust the HTTP request headers from your HeadersPrepared event handler.
This property is read-only and not available at design time.
Data Type
SecureBlackboxStringNameValuePair
RequestParameters Property (HTTPClient Class)
Provides access to common HTTP request properties.
Syntax
SecureBlackboxHTTPRequestParameters* GetRequestParameters(); int SetRequestParameters(SecureBlackboxHTTPRequestParameters* val);
char* secureblackbox_httpclient_getreqparamsaccept(void* lpObj);
int secureblackbox_httpclient_setreqparamsaccept(void* lpObj, const char* lpszReqParamsAccept);
char* secureblackbox_httpclient_getreqparamsacceptcharset(void* lpObj);
int secureblackbox_httpclient_setreqparamsacceptcharset(void* lpObj, const char* lpszReqParamsAcceptCharset);
char* secureblackbox_httpclient_getreqparamsacceptlanguage(void* lpObj);
int secureblackbox_httpclient_setreqparamsacceptlanguage(void* lpObj, const char* lpszReqParamsAcceptLanguage);
int64 secureblackbox_httpclient_getreqparamsacceptrangeend(void* lpObj);
int secureblackbox_httpclient_setreqparamsacceptrangeend(void* lpObj, int64 lReqParamsAcceptRangeEnd);
int64 secureblackbox_httpclient_getreqparamsacceptrangestart(void* lpObj);
int secureblackbox_httpclient_setreqparamsacceptrangestart(void* lpObj, int64 lReqParamsAcceptRangeStart);
char* secureblackbox_httpclient_getreqparamsauthorization(void* lpObj);
int secureblackbox_httpclient_setreqparamsauthorization(void* lpObj, const char* lpszReqParamsAuthorization);
char* secureblackbox_httpclient_getreqparamsconnection(void* lpObj);
int secureblackbox_httpclient_setreqparamsconnection(void* lpObj, const char* lpszReqParamsConnection);
int64 secureblackbox_httpclient_getreqparamscontentlength(void* lpObj);
int secureblackbox_httpclient_setreqparamscontentlength(void* lpObj, int64 lReqParamsContentLength);
int64 secureblackbox_httpclient_getreqparamscontentrangeend(void* lpObj);
int secureblackbox_httpclient_setreqparamscontentrangeend(void* lpObj, int64 lReqParamsContentRangeEnd);
int64 secureblackbox_httpclient_getreqparamscontentrangefullsize(void* lpObj);
int secureblackbox_httpclient_setreqparamscontentrangefullsize(void* lpObj, int64 lReqParamsContentRangeFullSize);
int64 secureblackbox_httpclient_getreqparamscontentrangestart(void* lpObj);
int secureblackbox_httpclient_setreqparamscontentrangestart(void* lpObj, int64 lReqParamsContentRangeStart);
char* secureblackbox_httpclient_getreqparamscontenttype(void* lpObj);
int secureblackbox_httpclient_setreqparamscontenttype(void* lpObj, const char* lpszReqParamsContentType);
char* secureblackbox_httpclient_getreqparamscookie(void* lpObj);
int secureblackbox_httpclient_setreqparamscookie(void* lpObj, const char* lpszReqParamsCookie);
char* secureblackbox_httpclient_getreqparamscustomheaders(void* lpObj);
int secureblackbox_httpclient_setreqparamscustomheaders(void* lpObj, const char* lpszReqParamsCustomHeaders);
char* secureblackbox_httpclient_getreqparamsdate(void* lpObj);
int secureblackbox_httpclient_setreqparamsdate(void* lpObj, const char* lpszReqParamsDate);
char* secureblackbox_httpclient_getreqparamsfrom(void* lpObj);
int secureblackbox_httpclient_setreqparamsfrom(void* lpObj, const char* lpszReqParamsFrom);
char* secureblackbox_httpclient_getreqparamshost(void* lpObj);
int secureblackbox_httpclient_setreqparamshost(void* lpObj, const char* lpszReqParamsHost);
int secureblackbox_httpclient_getreqparamshttpversion(void* lpObj);
int secureblackbox_httpclient_setreqparamshttpversion(void* lpObj, int iReqParamsHTTPVersion);
char* secureblackbox_httpclient_getreqparamsifmatch(void* lpObj);
int secureblackbox_httpclient_setreqparamsifmatch(void* lpObj, const char* lpszReqParamsIfMatch);
char* secureblackbox_httpclient_getreqparamsifmodifiedsince(void* lpObj);
int secureblackbox_httpclient_setreqparamsifmodifiedsince(void* lpObj, const char* lpszReqParamsIfModifiedSince);
char* secureblackbox_httpclient_getreqparamsifnonematch(void* lpObj);
int secureblackbox_httpclient_setreqparamsifnonematch(void* lpObj, const char* lpszReqParamsIfNoneMatch);
char* secureblackbox_httpclient_getreqparamsifunmodifiedsince(void* lpObj);
int secureblackbox_httpclient_setreqparamsifunmodifiedsince(void* lpObj, const char* lpszReqParamsIfUnmodifiedSince);
char* secureblackbox_httpclient_getreqparamspassword(void* lpObj);
int secureblackbox_httpclient_setreqparamspassword(void* lpObj, const char* lpszReqParamsPassword);
char* secureblackbox_httpclient_getreqparamsreferer(void* lpObj);
int secureblackbox_httpclient_setreqparamsreferer(void* lpObj, const char* lpszReqParamsReferer);
char* secureblackbox_httpclient_getreqparamsuseragent(void* lpObj);
int secureblackbox_httpclient_setreqparamsuseragent(void* lpObj, const char* lpszReqParamsUserAgent);
char* secureblackbox_httpclient_getreqparamsusername(void* lpObj);
int secureblackbox_httpclient_setreqparamsusername(void* lpObj, const char* lpszReqParamsUsername);
QString GetReqParamsAccept();
int SetReqParamsAccept(QString qsReqParamsAccept); QString GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(QString qsReqParamsAcceptCharset); QString GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(QString qsReqParamsAcceptLanguage); qint64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(qint64 lReqParamsAcceptRangeEnd); qint64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(qint64 lReqParamsAcceptRangeStart); QString GetReqParamsAuthorization();
int SetReqParamsAuthorization(QString qsReqParamsAuthorization); QString GetReqParamsConnection();
int SetReqParamsConnection(QString qsReqParamsConnection); qint64 GetReqParamsContentLength();
int SetReqParamsContentLength(qint64 lReqParamsContentLength); qint64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(qint64 lReqParamsContentRangeEnd); qint64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(qint64 lReqParamsContentRangeFullSize); qint64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(qint64 lReqParamsContentRangeStart); QString GetReqParamsContentType();
int SetReqParamsContentType(QString qsReqParamsContentType); QString GetReqParamsCookie();
int SetReqParamsCookie(QString qsReqParamsCookie); QString GetReqParamsCustomHeaders();
int SetReqParamsCustomHeaders(QString qsReqParamsCustomHeaders); QString GetReqParamsDate();
int SetReqParamsDate(QString qsReqParamsDate); QString GetReqParamsFrom();
int SetReqParamsFrom(QString qsReqParamsFrom); QString GetReqParamsHost();
int SetReqParamsHost(QString qsReqParamsHost); int GetReqParamsHTTPVersion();
int SetReqParamsHTTPVersion(int iReqParamsHTTPVersion); QString GetReqParamsIfMatch();
int SetReqParamsIfMatch(QString qsReqParamsIfMatch); QString GetReqParamsIfModifiedSince();
int SetReqParamsIfModifiedSince(QString qsReqParamsIfModifiedSince); QString GetReqParamsIfNoneMatch();
int SetReqParamsIfNoneMatch(QString qsReqParamsIfNoneMatch); QString GetReqParamsIfUnmodifiedSince();
int SetReqParamsIfUnmodifiedSince(QString qsReqParamsIfUnmodifiedSince); QString GetReqParamsPassword();
int SetReqParamsPassword(QString qsReqParamsPassword); QString GetReqParamsReferer();
int SetReqParamsReferer(QString qsReqParamsReferer); QString GetReqParamsUserAgent();
int SetReqParamsUserAgent(QString qsReqParamsUserAgent); QString GetReqParamsUsername();
int SetReqParamsUsername(QString qsReqParamsUsername);
Remarks
Use this property to configure the HTTP request properties.
This property is not available at design time.
Data Type
SecureBlackboxHTTPRequestParameters
ResponseHeaders Property (HTTPClient Class)
Contains the HTTP server's response headers.
Syntax
SecureBlackboxList<SecureBlackboxStringNameValuePair>* GetResponseHeaders();
int secureblackbox_httpclient_getrespheadercount(void* lpObj);
char* secureblackbox_httpclient_getrespheadercategory(void* lpObj, int respheaderindex);
int secureblackbox_httpclient_getrespheaderformat(void* lpObj, int respheaderindex);
char* secureblackbox_httpclient_getrespheadername(void* lpObj, int respheaderindex);
char* secureblackbox_httpclient_getrespheadervalue(void* lpObj, int respheaderindex);
int GetRespHeaderCount(); QString GetRespHeaderCategory(int iRespHeaderIndex); int GetRespHeaderFormat(int iRespHeaderIndex); QString GetRespHeaderName(int iRespHeaderIndex); QString GetRespHeaderValue(int iRespHeaderIndex);
Remarks
Use this property to check the headers of the HTTP response received from the server. The headers become available as soon as HeadersReceived event is fired.
This property is read-only and not available at design time.
Data Type
SecureBlackboxStringNameValuePair
ResponseParameters Property (HTTPClient Class)
Contains the HTTP server's response parameters.
Syntax
SecureBlackboxHTTPResponseParameters* GetResponseParameters();
int64 secureblackbox_httpclient_getrespparamscontentlength(void* lpObj);
char* secureblackbox_httpclient_getrespparamsdate(void* lpObj);
char* secureblackbox_httpclient_getrespparamsreasonphrase(void* lpObj);
int secureblackbox_httpclient_getrespparamsstatuscode(void* lpObj);
qint64 GetRespParamsContentLength(); QString GetRespParamsDate(); QString GetRespParamsReasonPhrase(); int GetRespParamsStatusCode();
Remarks
Use this property to access the properties of the received HTTP response.
This property is read-only and not available at design time.
Data Type
SecureBlackboxHTTPResponseParameters
SocketSettings Property (HTTPClient Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_httpclient_getsocketdnsmode(void* lpObj);
int secureblackbox_httpclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_httpclient_getsocketdnsport(void* lpObj);
int secureblackbox_httpclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_httpclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_httpclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_httpclient_getsocketdnsservers(void* lpObj);
int secureblackbox_httpclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_httpclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_httpclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_httpclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_httpclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_httpclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_httpclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_httpclient_getsocketlocalport(void* lpObj);
int secureblackbox_httpclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_httpclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_httpclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_httpclient_getsockettimeout(void* lpObj);
int secureblackbox_httpclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_httpclient_getsocketuseipv6(void* lpObj);
int secureblackbox_httpclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); 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
StatusCode Property (HTTPClient Class)
Contains the Status Code element of the server's response.
Syntax
ANSI (Cross Platform) int GetStatusCode(); Unicode (Windows) INT GetStatusCode();
int secureblackbox_httpclient_getstatuscode(void* lpObj);
int GetStatusCode();
Default Value
0
Remarks
Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).
This property is read-only and not available at design time.
Data Type
Integer
TLSClientChain Property (HTTPClient Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_httpclient_gettlsclientcertcount(void* lpObj);
int secureblackbox_httpclient_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_httpclient_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_httpclient_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_httpclient_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.
Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
Data Type
TLSServerChain Property (HTTPClient Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_httpclient_gettlsservercertcount(void* lpObj);
int secureblackbox_httpclient_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_httpclient_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_httpclient_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_httpclient_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_httpclient_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_httpclient_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_httpclient_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_httpclient_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_httpclient_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QString GetTLSServerCertFingerprint(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex); QString GetTLSServerCertIssuer(int iTLSServerCertIndex); QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex); QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex); int GetTLSServerCertKeyBits(int iTLSServerCertIndex); int GetTLSServerCertKeyUsage(int iTLSServerCertIndex); bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex); QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex); QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex); QString GetTLSServerCertSubject(int iTLSServerCertIndex); QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex); QString GetTLSServerCertValidFrom(int iTLSServerCertIndex); QString GetTLSServerCertValidTo(int iTLSServerCertIndex);
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.
This property is read-only and not available at design time.
Data Type
TLSSettings Property (HTTPClient Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_httpclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_httpclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_httpclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_httpclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_httpclient_gettlsciphersuites(void* lpObj);
int secureblackbox_httpclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_httpclient_gettlsclientauth(void* lpObj);
int secureblackbox_httpclient_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_httpclient_gettlseccurves(void* lpObj);
int secureblackbox_httpclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_httpclient_gettlsextensions(void* lpObj);
int secureblackbox_httpclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_httpclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_httpclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_httpclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_httpclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_httpclient_gettlspresharedkey(void* lpObj);
int secureblackbox_httpclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_httpclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_httpclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_httpclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_httpclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_httpclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_httpclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_httpclient_gettlsssloptions(void* lpObj);
int secureblackbox_httpclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_httpclient_gettlstlsmode(void* lpObj);
int secureblackbox_httpclient_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_httpclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_httpclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_httpclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_httpclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_httpclient_gettlsversions(void* lpObj);
int secureblackbox_httpclient_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
TrustedCertificates Property (HTTPClient Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_httpclient_gettrustedcertcount(void* lpObj);
int secureblackbox_httpclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_httpclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_httpclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_httpclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Remarks
Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
This property is not available at design time.
Data Type
Config Method (HTTPClient Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_httpclient_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.
Delete Method (HTTPClient Class)
Sends a DELETE request to the server.
Syntax
ANSI (Cross Platform) int Delete(const char* lpszUrl); Unicode (Windows) INT Delete(LPCWSTR lpszUrl);
int secureblackbox_httpclient_delete(void* lpObj, const char* lpszUrl);
int Delete(const QString& qsUrl);
Remarks
Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in Url. Most of the servers disable DELETE requests.
If this request fails, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
DoAction Method (HTTPClient Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_httpclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
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.
Get Method (HTTPClient Class)
Sends a GET request to the server.
Syntax
ANSI (Cross Platform) int Get(const char* lpszUrl); Unicode (Windows) INT Get(LPCWSTR lpszUrl);
int secureblackbox_httpclient_get(void* lpObj, const char* lpszUrl);
int Get(const QString& qsUrl);
Remarks
GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.
If the request is successful, the received content will be available in OutputBytes and OutputString properties. Otherwise an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
Head Method (HTTPClient Class)
Sends a HEAD request to the server.
Syntax
ANSI (Cross Platform) int Head(const char* lpszUrl); Unicode (Windows) INT Head(LPCWSTR lpszUrl);
int secureblackbox_httpclient_head(void* lpObj, const char* lpszUrl);
int Head(const QString& qsUrl);
Remarks
HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned.
HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via ResponseParameters and ResponseHeaders properties. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
Options Method (HTTPClient Class)
Sends an OPTIONS request to the server.
Syntax
ANSI (Cross Platform) int Options(const char* lpszUrl); Unicode (Windows) INT Options(LPCWSTR lpszUrl);
int secureblackbox_httpclient_options(void* lpObj, const char* lpszUrl);
int Options(const QString& qsUrl);
Remarks
This request gets various information about the server such as supported HTTP methods. No content is included in the response.
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.)
Post Method (HTTPClient Class)
Sends a POST request to the server.
Syntax
ANSI (Cross Platform) int Post(const char* lpszUrl, const char* lpszContent); Unicode (Windows) INT Post(LPCWSTR lpszUrl, LPCWSTR lpszContent);
int secureblackbox_httpclient_post(void* lpObj, const char* lpszUrl, const char* lpszContent);
int Post(const QString& qsUrl, const QString& qsContent);
Remarks
POST is used to send data to the remote HTTP endpoint/script.
Provide the data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.
To post a web form's data (including file attachments to the form) use PostWebForm method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PostBytes Method (HTTPClient Class)
Sends a POST request to the server.
Syntax
ANSI (Cross Platform) int PostBytes(const char* lpszUrl, const char* lpContentBytes, int lenContentBytes); Unicode (Windows) INT PostBytes(LPCWSTR lpszUrl, LPCSTR lpContentBytes, INT lenContentBytes);
int secureblackbox_httpclient_postbytes(void* lpObj, const char* lpszUrl, const char* lpContentBytes, int lenContentBytes);
int PostBytes(const QString& qsUrl, QByteArray qbaContentBytes);
Remarks
POST is used to send data to the remote HTTP endpoint/script.
Provide the data you need to send via the ContentBytes parameter. If content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.
To post a web form's data (including file attachments to the form) use PostWebForm method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PostFile Method (HTTPClient Class)
Sends a file to the server using a POST request.
Syntax
ANSI (Cross Platform) int PostFile(const char* lpszUrl, const char* lpszFileName); Unicode (Windows) INT PostFile(LPCWSTR lpszUrl, LPCWSTR lpszFileName);
int secureblackbox_httpclient_postfile(void* lpObj, const char* lpszUrl, const char* lpszFileName);
int PostFile(const QString& qsUrl, const QString& qsFileName);
Remarks
POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from FileName.
To post a web form's data (including file attachments to the form) use PostWebForm method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PostStream Method (HTTPClient Class)
Sends a POST request to the server.
Syntax
ANSI (Cross Platform) int PostStream(const char* lpszUrl, SecureBlackboxStream* sInputStream); Unicode (Windows) INT PostStream(LPCWSTR lpszUrl, SecureBlackboxStream* sInputStream);
int secureblackbox_httpclient_poststream(void* lpObj, const char* lpszUrl, SecureBlackboxStream* sInputStream);
int PostStream(const QString& qsUrl, SecureBlackboxStream* sInputStream);
Remarks
POST is used to send data to the remote HTTP endpoint/script.
Provide the data you need to send via the InputStream parameter.
To post a web form data (including file attachments to the form) use PostWebForm method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PostWebForm Method (HTTPClient Class)
Posts a web form data to the server.
Syntax
ANSI (Cross Platform) int PostWebForm(const char* lpszUrl, const char* lpszFields, const char* lpszFileField, const char* lpszFileName, const char* lpszContentType); Unicode (Windows) INT PostWebForm(LPCWSTR lpszUrl, LPCWSTR lpszFields, LPCWSTR lpszFileField, LPCWSTR lpszFileName, LPCWSTR lpszContentType);
int secureblackbox_httpclient_postwebform(void* lpObj, const char* lpszUrl, const char* lpszFields, const char* lpszFileField, const char* lpszFileName, const char* lpszContentType);
int PostWebForm(const QString& qsUrl, const QString& qsFields, const QString& qsFileField, const QString& qsFileName, const QString& qsContentType);
Remarks
This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. Fields are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty.
If including a file with your request, use the FileField and FileName properties to specify the file field name and the local filename for the uploaded file. Use ContentType to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded".
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
Put Method (HTTPClient Class)
Sends a PUT request to the server.
Syntax
ANSI (Cross Platform) int Put(const char* lpszUrl, const char* lpszContent); Unicode (Windows) INT Put(LPCWSTR lpszUrl, LPCWSTR lpszContent);
int secureblackbox_httpclient_put(void* lpObj, const char* lpszUrl, const char* lpszContent);
int Put(const QString& qsUrl, const QString& qsContent);
Remarks
PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.
If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PutBytes Method (HTTPClient Class)
Sends a PUT request to the server.
Syntax
ANSI (Cross Platform) int PutBytes(const char* lpszUrl, const char* lpContentBytes, int lenContentBytes); Unicode (Windows) INT PutBytes(LPCWSTR lpszUrl, LPCSTR lpContentBytes, INT lenContentBytes);
int secureblackbox_httpclient_putbytes(void* lpObj, const char* lpszUrl, const char* lpContentBytes, int lenContentBytes);
int PutBytes(const QString& qsUrl, QByteArray qbaContentBytes);
Remarks
PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.
If ContentBytes is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PutFile Method (HTTPClient Class)
Sends a file to the server using a PUT request.
Syntax
ANSI (Cross Platform) int PutFile(const char* lpszUrl, const char* lpszFileName); Unicode (Windows) INT PutFile(LPCWSTR lpszUrl, LPCWSTR lpszFileName);
int secureblackbox_httpclient_putfile(void* lpObj, const char* lpszUrl, const char* lpszFileName);
int PutFile(const QString& qsUrl, const QString& qsFileName);
Remarks
PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from FileName.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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.)
PutStream Method (HTTPClient Class)
Sends a PUT request to the server.
Syntax
ANSI (Cross Platform) int PutStream(const char* lpszUrl, SecureBlackboxStream* sInputStream); Unicode (Windows) INT PutStream(LPCWSTR lpszUrl, SecureBlackboxStream* sInputStream);
int secureblackbox_httpclient_putstream(void* lpObj, const char* lpszUrl, SecureBlackboxStream* sInputStream);
int PutStream(const QString& qsUrl, SecureBlackboxStream* sInputStream);
Remarks
PUT is an alternative to POST, and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off.
Provide the data you need to send via the InputStream parameter.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
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 (HTTPClient Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_httpclient_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.)
Trace Method (HTTPClient Class)
Sends a TRACE request to the server.
Syntax
ANSI (Cross Platform) int Trace(const char* lpszUrl); Unicode (Windows) INT Trace(LPCWSTR lpszUrl);
int secureblackbox_httpclient_trace(void* lpObj, const char* lpszUrl);
int Trace(const QString& qsUrl);
Remarks
TRACE is a debug command and is typically switched off and/or not supported by web servers.
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.)
Cookie Event (HTTPClient Class)
Fired to report a received cookie.
Syntax
ANSI (Cross Platform) virtual int FireCookie(HTTPClientCookieEventParams *e);
typedef struct {
const char *CookieText; int reserved; } HTTPClientCookieEventParams;
Unicode (Windows) virtual INT FireCookie(HTTPClientCookieEventParams *e);
typedef struct {
LPCWSTR CookieText; INT reserved; } HTTPClientCookieEventParams;
#define EID_HTTPCLIENT_COOKIE 1 virtual INT SECUREBLACKBOX_CALL FireCookie(LPSTR &lpszCookieText);
class HTTPClientCookieEventParams { public: const QString &CookieText(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Cookie(HTTPClientCookieEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireCookie(HTTPClientCookieEventParams *e) {...}
Remarks
The CookieText parameter contains the text of the cookie.
DocumentBegin Event (HTTPClient Class)
Marks the start of the incoming HTML document or file.
Syntax
ANSI (Cross Platform) virtual int FireDocumentBegin(HTTPClientDocumentBeginEventParams *e);
typedef struct { int reserved; } HTTPClientDocumentBeginEventParams;
Unicode (Windows) virtual INT FireDocumentBegin(HTTPClientDocumentBeginEventParams *e);
typedef struct { INT reserved; } HTTPClientDocumentBeginEventParams;
#define EID_HTTPCLIENT_DOCUMENTBEGIN 2 virtual INT SECUREBLACKBOX_CALL FireDocumentBegin();
class HTTPClientDocumentBeginEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DocumentBegin(HTTPClientDocumentBeginEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireDocumentBegin(HTTPClientDocumentBeginEventParams *e) {...}
Remarks
This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.
DocumentEnd Event (HTTPClient Class)
Marks the successful receipt of the incoming HTML document or file.
Syntax
ANSI (Cross Platform) virtual int FireDocumentEnd(HTTPClientDocumentEndEventParams *e);
typedef struct { int reserved; } HTTPClientDocumentEndEventParams;
Unicode (Windows) virtual INT FireDocumentEnd(HTTPClientDocumentEndEventParams *e);
typedef struct { INT reserved; } HTTPClientDocumentEndEventParams;
#define EID_HTTPCLIENT_DOCUMENTEND 3 virtual INT SECUREBLACKBOX_CALL FireDocumentEnd();
class HTTPClientDocumentEndEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DocumentEnd(HTTPClientDocumentEndEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireDocumentEnd(HTTPClientDocumentEndEventParams *e) {...}
Remarks
This event fires when the document has been received in full.
DynamicDataNeeded Event (HTTPClient Class)
Requests a portion of data to be uploaded from the application.
Syntax
ANSI (Cross Platform) virtual int FireDynamicDataNeeded(HTTPClientDynamicDataNeededEventParams *e);
typedef struct {
int BytesNeeded; int reserved; } HTTPClientDynamicDataNeededEventParams;
Unicode (Windows) virtual INT FireDynamicDataNeeded(HTTPClientDynamicDataNeededEventParams *e);
typedef struct {
INT BytesNeeded; INT reserved; } HTTPClientDynamicDataNeededEventParams;
#define EID_HTTPCLIENT_DYNAMICDATANEEDED 4 virtual INT SECUREBLACKBOX_CALL FireDynamicDataNeeded(INT &iBytesNeeded);
class HTTPClientDynamicDataNeededEventParams { public: int BytesNeeded(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DynamicDataNeeded(HTTPClientDynamicDataNeededEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireDynamicDataNeeded(HTTPClientDynamicDataNeededEventParams *e) {...}
Remarks
If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server.
When handling this event, assign the next portion of data of BytesNeeded length (or less) to DynamicData. If no more data is available to upload (the whole document has been sent), leave DynamicData empty.
Error Event (HTTPClient Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(HTTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } HTTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(HTTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } HTTPClientErrorEventParams;
#define EID_HTTPCLIENT_ERROR 5 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class HTTPClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(HTTPClientErrorEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireError(HTTPClientErrorEventParams *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 (HTTPClient Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(HTTPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } HTTPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(HTTPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } HTTPClientExternalSignEventParams;
#define EID_HTTPCLIENT_EXTERNALSIGN 6 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class HTTPClientExternalSignEventParams { public: 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(HTTPClientExternalSignEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireExternalSign(HTTPClientExternalSignEventParams *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();
};
HeadersPrepared Event (HTTPClient Class)
Fires when the request headers have been formed and are about to be sent to the server.
Syntax
ANSI (Cross Platform) virtual int FireHeadersPrepared(HTTPClientHeadersPreparedEventParams *e);
typedef struct { int reserved; } HTTPClientHeadersPreparedEventParams;
Unicode (Windows) virtual INT FireHeadersPrepared(HTTPClientHeadersPreparedEventParams *e);
typedef struct { INT reserved; } HTTPClientHeadersPreparedEventParams;
#define EID_HTTPCLIENT_HEADERSPREPARED 7 virtual INT SECUREBLACKBOX_CALL FireHeadersPrepared();
class HTTPClientHeadersPreparedEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void HeadersPrepared(HTTPClientHeadersPreparedEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireHeadersPrepared(HTTPClientHeadersPreparedEventParams *e) {...}
Remarks
The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.
HeadersReceived Event (HTTPClient Class)
Fires when the HTTP response headers have just been received from the server.
Syntax
ANSI (Cross Platform) virtual int FireHeadersReceived(HTTPClientHeadersReceivedEventParams *e);
typedef struct { int reserved; } HTTPClientHeadersReceivedEventParams;
Unicode (Windows) virtual INT FireHeadersReceived(HTTPClientHeadersReceivedEventParams *e);
typedef struct { INT reserved; } HTTPClientHeadersReceivedEventParams;
#define EID_HTTPCLIENT_HEADERSRECEIVED 8 virtual INT SECUREBLACKBOX_CALL FireHeadersReceived();
class HTTPClientHeadersReceivedEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void HeadersReceived(HTTPClientHeadersReceivedEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireHeadersReceived(HTTPClientHeadersReceivedEventParams *e) {...}
Remarks
The received headers are available via the ResponseHeaders property.
Notification Event (HTTPClient Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(HTTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } HTTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(HTTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } HTTPClientNotificationEventParams;
#define EID_HTTPCLIENT_NOTIFICATION 9 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class HTTPClientNotificationEventParams { 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(HTTPClientNotificationEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireNotification(HTTPClientNotificationEventParams *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.
This class can fire this event with the following EventID values:
TLSExtensions.CertificateStatus | TBD |
TLSExtensions.PreSharedIdentityHint | TBD |
Progress Event (HTTPClient Class)
Fires periodically during the data transfer.
Syntax
ANSI (Cross Platform) virtual int FireProgress(HTTPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } HTTPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(HTTPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } HTTPClientProgressEventParams;
#define EID_HTTPCLIENT_PROGRESS 10 virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class HTTPClientProgressEventParams { public: qint64 Total(); qint64 Current(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(HTTPClientProgressEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireProgress(HTTPClientProgressEventParams *e) {...}
Remarks
Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.
Redirection Event (HTTPClient Class)
Fires when the server suggests a redirect.
Syntax
ANSI (Cross Platform) virtual int FireRedirection(HTTPClientRedirectionEventParams *e);
typedef struct {
const char *OldURL;
char *NewURL;
int AllowRedirection; int reserved; } HTTPClientRedirectionEventParams;
Unicode (Windows) virtual INT FireRedirection(HTTPClientRedirectionEventParams *e);
typedef struct {
LPCWSTR OldURL;
LPWSTR NewURL;
BOOL AllowRedirection; INT reserved; } HTTPClientRedirectionEventParams;
#define EID_HTTPCLIENT_REDIRECTION 11 virtual INT SECUREBLACKBOX_CALL FireRedirection(LPSTR &lpszOldURL, LPSTR &lpszNewURL, BOOL &bAllowRedirection);
class HTTPClientRedirectionEventParams { public: const QString &OldURL(); const QString &NewURL(); void SetNewURL(const QString &qsNewURL); bool AllowRedirection(); void SetAllowRedirection(bool bAllowRedirection); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Redirection(HTTPClientRedirectionEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireRedirection(HTTPClientRedirectionEventParams *e) {...}
Remarks
This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.
Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.
TLSCertNeeded Event (HTTPClient Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(HTTPClientTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } HTTPClientTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(HTTPClientTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } HTTPClientTLSCertNeededEventParams;
#define EID_HTTPCLIENT_TLSCERTNEEDED 12 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class HTTPClientTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(HTTPClientTLSCertNeededEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSCertNeeded(HTTPClientTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (HTTPClient Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(HTTPClientTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } HTTPClientTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(HTTPClientTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } HTTPClientTLSCertValidateEventParams;
#define EID_HTTPCLIENT_TLSCERTVALIDATE 13 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class HTTPClientTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(HTTPClientTLSCertValidateEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSCertValidate(HTTPClientTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.
TLSEstablished Event (HTTPClient Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(HTTPClientTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } HTTPClientTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(HTTPClientTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } HTTPClientTLSEstablishedEventParams;
#define EID_HTTPCLIENT_TLSESTABLISHED 14 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class HTTPClientTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(HTTPClientTLSEstablishedEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSEstablished(HTTPClientTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about a successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (HTTPClient Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(HTTPClientTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } HTTPClientTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(HTTPClientTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } HTTPClientTLSHandshakeEventParams;
#define EID_HTTPCLIENT_TLSHANDSHAKE 15 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class HTTPClientTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(HTTPClientTLSHandshakeEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSHandshake(HTTPClientTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.
TLSPSK Event (HTTPClient Class)
Notifies the application about the PSK key exchange.
Syntax
ANSI (Cross Platform) virtual int FireTLSPSK(HTTPClientTLSPSKEventParams *e);
typedef struct {
const char *Host;
const char *Hint; int reserved; } HTTPClientTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(HTTPClientTLSPSKEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Hint; INT reserved; } HTTPClientTLSPSKEventParams;
#define EID_HTTPCLIENT_TLSPSK 16 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);
class HTTPClientTLSPSKEventParams { public: const QString &Host(); const QString &Hint(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(HTTPClientTLSPSKEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSPSK(HTTPClientTLSPSKEventParams *e) {...}
Remarks
The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.
TLSShutdown Event (HTTPClient Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(HTTPClientTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } HTTPClientTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(HTTPClientTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } HTTPClientTLSShutdownEventParams;
#define EID_HTTPCLIENT_TLSSHUTDOWN 17 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class HTTPClientTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(HTTPClientTLSShutdownEventParams *e);
// Or, subclass HTTPClient and override this emitter function. virtual int FireTLSShutdown(HTTPClientTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
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
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Syntax
SecureBlackboxCRL (declared in secureblackbox.h)
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char*
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char*
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
CRL()
Creates an empty CRL object.
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
AsyncDocumentID
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
HTTPRequestParameters Type
Represents the headers of the HTTP request to make.
Syntax
SecureBlackboxHTTPRequestParameters (declared in secureblackbox.h)
Remarks
If a header is not assigned but required for a successful request (such as Connection or Host), it will be generated automatically by the class.
Fields
Accept
char*
Default Value: ""
Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.
AcceptCharset
char*
Default Value: ""
Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.
AcceptLanguage
char*
Default Value: ""
Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.
AcceptRangeEnd
int64
Default Value: 0
This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.
AcceptRangeStart
int64
Default Value: 0
This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.
Authorization
char*
Default Value: ""
Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.
Connection
char*
Default Value: ""
Specifies the value to pass to the Connection header field of HTTP request.
ContentLength
int64
Default Value: 0
Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically.
ContentRangeEnd
int64
Default Value: 0
Specifies the upper bound used in the Content-Range header of the HTTP request.
ContentRangeFullSize
int64
Default Value: 0
Specifies the total length of the full entity-body of the HTTP request.
ContentRangeStart
int64
Default Value: 0
Specifies the lower bound used in the Content-Range header of the HTTP request.
ContentType
char*
Default Value: ""
The Content-Type header field of the HTTP request.
Cookie
char*
Default Value: ""
This header is expected to be assigned with cookies previously received from the server and stored by the client.
CustomHeaders
char*
Default Value: ""
Assign any custom HTTP headers to be passed to the server to this property.
Date
char*
Default Value: ""
The date and time of the request.
From
char*
Default Value: ""
Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.
Host
char*
Default Value: ""
This field contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.
HTTPVersion
int
Default Value: 1
Specifies the version of HTTP protocol to use: 1.0 or 1.1.
chvHTTP10 | HTTP/1.0 (0) |
chvHTTP11 | HTTP/1.1 (1) |
IfMatch
char*
Default Value: ""
Contains the If-Match request header field. This field makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.
IfModifiedSince
char*
Default Value: ""
Contains the If-Modified-Since request header field. This field makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.
IfNoneMatch
char*
Default Value: ""
Contains the If-None-Match request header field. This field makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.
IfUnmodifiedSince
char*
Default Value: ""
Contains the If-Unmodified-Since request header field. This field makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.
Password
char*
Default Value: ""
Assign this property with the user's password.
Referer
char*
Default Value: ""
The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).
UserAgent
char*
Default Value: ""
The User-Agent field of the HTTP request provides information about the software that initiates the request.
Username
char*
Default Value: ""
Assign this property with the user's login name.
Constructors
HTTPRequestParameters()
Creates a new HTTPRequestParameters object.
HTTPResponseParameters Type
This object is a container for HTTP server response details.
Syntax
SecureBlackboxHTTPResponseParameters (declared in secureblackbox.h)
Remarks
An HTTP response is sent by the server when it has processed the client's request. The response consists of the status code (perhaps, the most annoying and widely known one is 404), the reason phrase, the response headers, and the body (the actual data) of the response.
Fields
ContentLength
int64
Default Value: 0
Indicates the length of the response content in bytes.
Date
char*
Default Value: ""
The date and time at which the response was generated, in server time, in UTC.
ReasonPhrase
char*
Default Value: ""
Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.
StatusCode
int
Default Value: 0
The server-generated status code of the request processing status.
The code is a 3-digit integer where the first digit defines the class of the response:
1 | Informational |
2 | Success |
3 | Redirection |
4 | Client Error |
5 | Server Error |
Common examples are 200 (page served succesfully), 404 (page not found), 302 (redirect), and 500 (internal server error).
Constructors
HTTPResponseParameters()
Creates a new HTTPResponseParameters object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Syntax
SecureBlackboxOCSPResponse (declared in secureblackbox.h)
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
Bytes
char* (read-only)
Default Value:
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
char*
Default Value: ""
Specifies the time when the response was produced, in UTC.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Syntax
SecureBlackboxProxySettings (declared in secureblackbox.h)
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
char*
Default Value: ""
The IP address of the proxy server.
Authentication
int
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
char*
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
int
Default Value: 0
The type of the proxy server.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
char*
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
char*
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
char*
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
int
Default Value: FALSE
Specifies whether IPv6 should be used when connecting through the proxy.
Username
char*
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
ProxySettings()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
StringNameValuePair Type
A simple name-value pair object.
Syntax
SecureBlackboxStringNameValuePair (declared in secureblackbox.h)
Remarks
The class represents a name-value string pair used in a variety of network components.
Fields
Category
char*
Default Value: ""
Specifies the string category of the contained value.
This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.
For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.
Format
int
Default Value: 0
Specifies the format (encoding) of the value contained in the Value property.
Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate
format that matches this setting:
utils.NameValuePairs[0].Name = "key";
utils.NameValuePairs[0].Format = svfBinary;
utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";
The following formats are currently supported:
svfText | 0 | The property contains text |
svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. |
Name
char*
Default Value: ""
The name element in a (name, value) pair.
Value
char*
Default Value: ""
The value element in a (name, value) pair.
Constructors
StringNameValuePair(const char* lpszName, const char* lpszValue)
Creates a name-value pair from a name and a value.
StringNameValuePair()
Creates an empty name-value object.
TLSConnectionInfo Type
Contains information about a network connection.
Syntax
SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
AEADCipher
int (read-only)
Default Value: FALSE
Indicates whether the encryption algorithm used is an AEAD cipher.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
Ciphersuite
char* (read-only)
Default Value: ""
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
ClientAuthenticated
int (read-only)
Default Value: FALSE
Specifies whether client authentication was performed during this connection.
ClientAuthRequested
int (read-only)
Default Value: FALSE
Specifies whether client authentication was requested during this connection.
ConnectionEstablished
int (read-only)
Default Value: FALSE
Indicates whether the connection has been established fully.
ConnectionID
char* (read-only)
Default Value:
The unique identifier assigned to this connection.
DigestAlgorithm
char* (read-only)
Default Value: ""
The digest algorithm used in a TLS-enabled connection.
EncryptionAlgorithm
char* (read-only)
Default Value: ""
The symmetric encryption algorithm used in a TLS-enabled connection.
Exportable
int (read-only)
Default Value: FALSE
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ID
int64 (read-only)
Default Value: -1
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
KeyExchangeAlgorithm
char* (read-only)
Default Value: ""
The key exchange algorithm used in a TLS-enabled connection.
KeyExchangeKeyBits
int (read-only)
Default Value: 0
The length of the key exchange key of a TLS-enabled connection.
NamedECCurve
char* (read-only)
Default Value: ""
The elliptic curve used in this connection.
PFSCipher
int (read-only)
Default Value: FALSE
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PreSharedIdentity
char*
Default Value: ""
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedIdentityHint
char* (read-only)
Default Value: ""
A hint professed by the server to help the client select the PSK identity to use.
PublicKeyBits
int (read-only)
Default Value: 0
The length of the public key.
RemoteAddress
char* (read-only)
Default Value: ""
The client's IP address.
RemotePort
int (read-only)
Default Value: 0
The remote port of the client connection.
ResumedSession
int (read-only)
Default Value: FALSE
Indicates whether a TLS-enabled connection was spawned from another TLS connection
SecureConnection
int (read-only)
Default Value: FALSE
Indicates whether TLS or SSL is enabled for this connection.
ServerAuthenticated
int (read-only)
Default Value: FALSE
Indicates whether server authentication was performed during a TLS-enabled connection.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The signature algorithm used in a TLS handshake.
SymmetricBlockSize
int (read-only)
Default Value: 0
The block size of the symmetric algorithm used.
SymmetricKeyBits
int (read-only)
Default Value: 0
The key length of the symmetric algorithm used.
TotalBytesReceived
int64 (read-only)
Default Value: 0
The total number of bytes received over this connection.
TotalBytesSent
int64 (read-only)
Default Value: 0
The total number of bytes sent over this connection.
ValidationLog
char* (read-only)
Default Value: ""
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Version
char* (read-only)
Default Value: ""
Indicates the version of SSL/TLS protocol negotiated during this connection.
Constructors
TLSConnectionInfo()
Creates a new TLSConnectionInfo object.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the HTTPClient class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The HTTPClient class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the HTTPClient class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (HTTPClient Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.HTTPClient Config Settings
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (HTTPClient Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
HTTPClient Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
19922945 | Unsupported keep-alive policy (SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY) |
19922946 | Wrong request filter string format (SB_ERROR_HTTP_WRONG_REQUEST_FILTER_FORMAT) |