DCAuthWebServer Class
Properties Methods Events Config Settings Errors
The DCAuthWebServer Class offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.
Syntax
DCAuthWebServer
Remarks
DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific Port or a port chosen between PortRangeFrom and PortRangeTo. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Active | Indicates whether the server is active and is listening to new connections. |
AllowOrigin | Specifies the content of AllowOrigin header of the service reply. |
AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
AuthTypes | Defines allowed HTTP authentication types. |
BoundPort | Indicates the bound listening port. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | The host to bind the listening port to. |
KeyId | Specifies the KeyID of the pre-shared authentication key. |
KeySecret | The pre-shared authentication key. |
PinnedClient | Populates the pinned client details. |
PinnedClientChain | Contains the certificate chain of the pinned client. |
Policies | Specifies the policies to use when processing requests. |
Port | Specifies the port number to listen for connections on. |
PortRangeFrom | Specifies the lower limit of the listening port range for incoming connections. |
PortRangeTo | Specifies the upper limit of the listening port range for incoming connections. |
SessionTimeout | Specifies the default session timeout value in milliseconds. |
SignEndpoint | The signing service endpoint. |
SigningCertificate | The certificate to be used for signing. |
SigningChain | The signing certificate chain. |
SocketSettings | Manages network connection settings. |
StorageId | Specifies the signing certificate residing in an alternative location. |
TimestampServer | The address of the timestamping server. |
TLSServerChain | The server's TLS certificates. |
TLSSettings | Manages TLS layer settings. |
Users | Provides a list of registered users. |
WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
Reset | Resets the class settings. |
Start | Starts the server. |
Stop | Stops the server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Accept | Reports an incoming connection. |
AuthAttempt | Fires when a connected client makes an authentication attempt. |
Connect | Reports an accepted connection. |
CustomParametersReceived | Passes custom request parameters to the application. |
Disconnect | Fires to report a disconnected client. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
KeySecretNeeded | Requests the key secret from the application. |
Log | Reports a single log line. |
Notification | This event notifies the application about an underlying control flow event. |
ParameterReceived | Passes a standard request parameter to the user code. |
PasswordNeeded | Requests a password from the application. |
ReadOption | Fires when the client sends in a read option request. |
SelectCert | Requests certificate selection criteria from the application. |
SignRequest | This event signifies the processing of an atomic signing request. |
SignRequestCompleted | This event signifies completion of the processing of an atomic signing request. |
TimestampRequest | Fires when the class is ready to request a timestamp from an external TSA. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
WriteOption | Fires when the client sends in a write option request. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
CertPassword | TBD. |
CertStoragePath | TBD. |
DataURL | (obsolete) The DataURL parameter to pass to the signer. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
FingerprintAlgorithm | The fingeprint algorithm to use. |
GoURL | (obsolete) The GoURL parameter to pass to the signer. |
HandshakeTimeout | The HTTPS handshake timeout. |
Host | The host to bind to. |
Is64BitProcess | TBD. |
KeysEndpoint | TBD. |
KeyStoragePath | TBD. |
PolicyHash | The EPES policy hash. |
PolicyHashAlgorithm | The EPES policy hash algorithm. |
PolicyID | The EPES policy identifier. |
PolicyURI | The EPES policy URL. |
Port | The port to listen on. |
Port64 | TBD. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
ReadOnlyMode | TBD. |
RequireDefinedSignCert | (obsolete) The RequireDefinedSignCert parameter to pass to the signer. |
SchemeParams | The algorithm scheme parameters to employ. |
ServerCertificatePassword | TBD. |
ServerCertificatePath | TBD. |
SessionID | (obsolete) The SessionID parameter to pass to the signer. |
SessionTimeout | The HTTP session timeout. |
SettingsEndpoint | TBD. |
StatusEndpoint | TBD. |
TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
TLSExtensions | TBD. |
TLSValidationLog | Contains the log of the TLS server certificate validation. |
TokenName | The TokenName parameter to pass to the signer. |
TokensLibraries | (obsolete) The TokensLibraries parameter to pass to the signer. |
TspAttemptCount | Specifies the number of timestamping request attempts. |
TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
Use64BitService | TBD. |
WebsiteName | The website name for the TLS certificate. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (DCAuthWebServer Class)
Indicates whether the server is active and is listening to new connections.
Syntax
ANSI (Cross Platform) int GetActive(); Unicode (Windows) BOOL GetActive();
int secureblackbox_dcauthwebserver_getactive(void* lpObj);
bool GetActive();
Default Value
FALSE
Remarks
This read-only property returns True if the server is listening to incoming connections.
This property is read-only and not available at design time.
Data Type
Boolean
AllowOrigin Property (DCAuthWebServer Class)
Specifies the content of AllowOrigin header of the service reply.
Syntax
ANSI (Cross Platform) char* GetAllowOrigin();
int SetAllowOrigin(const char* lpszAllowOrigin); Unicode (Windows) LPWSTR GetAllowOrigin();
INT SetAllowOrigin(LPCWSTR lpszAllowOrigin);
char* secureblackbox_dcauthwebserver_getalloworigin(void* lpObj);
int secureblackbox_dcauthwebserver_setalloworigin(void* lpObj, const char* lpszAllowOrigin);
QString GetAllowOrigin();
int SetAllowOrigin(QString qsAllowOrigin);
Default Value
""
Remarks
Use this property to specify the content of AllowOrigin header included with the service reply. If left empty, the * header will be returned.
Data Type
String
AuthRealm Property (DCAuthWebServer Class)
Specifies authentication realm for digest and NTLM authentication.
Syntax
ANSI (Cross Platform) char* GetAuthRealm();
int SetAuthRealm(const char* lpszAuthRealm); Unicode (Windows) LPWSTR GetAuthRealm();
INT SetAuthRealm(LPCWSTR lpszAuthRealm);
char* secureblackbox_dcauthwebserver_getauthrealm(void* lpObj);
int secureblackbox_dcauthwebserver_setauthrealm(void* lpObj, const char* lpszAuthRealm);
QString GetAuthRealm();
int SetAuthRealm(QString qsAuthRealm);
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
Data Type
String
AuthTypes Property (DCAuthWebServer 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_dcauthwebserver_getauthtypes(void* lpObj);
int secureblackbox_dcauthwebserver_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
BoundPort Property (DCAuthWebServer Class)
Indicates the bound listening port.
Syntax
ANSI (Cross Platform) int GetBoundPort(); Unicode (Windows) INT GetBoundPort();
int secureblackbox_dcauthwebserver_getboundport(void* lpObj);
int GetBoundPort();
Default Value
0
Remarks
Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.
This property is read-only and not available at design time.
Data Type
Integer
ExternalCrypto Property (DCAuthWebServer Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_dcauthwebserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_dcauthwebserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_dcauthwebserver_getexternalcryptodata(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_dcauthwebserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_dcauthwebserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_dcauthwebserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_dcauthwebserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_dcauthwebserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_dcauthwebserver_getexternalcryptomode(void* lpObj);
int secureblackbox_dcauthwebserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_dcauthwebserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_dcauthwebserver_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 (DCAuthWebServer Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_dcauthwebserver_getfipsmode(void* lpObj);
int secureblackbox_dcauthwebserver_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
HandshakeTimeout Property (DCAuthWebServer Class)
Specifies the handshake timeout in milliseconds.
Syntax
ANSI (Cross Platform) int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout); Unicode (Windows) INT GetHandshakeTimeout();
INT SetHandshakeTimeout(INT iHandshakeTimeout);
int secureblackbox_dcauthwebserver_gethandshaketimeout(void* lpObj);
int secureblackbox_dcauthwebserver_sethandshaketimeout(void* lpObj, int iHandshakeTimeout);
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
Integer
Host Property (DCAuthWebServer Class)
The host to bind the listening port to.
Syntax
ANSI (Cross Platform) char* GetHost();
int SetHost(const char* lpszHost); Unicode (Windows) LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);
char* secureblackbox_dcauthwebserver_gethost(void* lpObj);
int secureblackbox_dcauthwebserver_sethost(void* lpObj, const char* lpszHost);
QString GetHost();
int SetHost(QString qsHost);
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections.
Data Type
String
KeyId Property (DCAuthWebServer Class)
Specifies the KeyID of the pre-shared authentication key.
Syntax
ANSI (Cross Platform) char* GetKeyId();
int SetKeyId(const char* lpszKeyId); Unicode (Windows) LPWSTR GetKeyId();
INT SetKeyId(LPCWSTR lpszKeyId);
char* secureblackbox_dcauthwebserver_getkeyid(void* lpObj);
int secureblackbox_dcauthwebserver_setkeyid(void* lpObj, const char* lpszKeyId);
QString GetKeyId();
int SetKeyId(QString qsKeyId);
Default Value
""
Remarks
If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the KeySecret property. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
Data Type
String
KeySecret Property (DCAuthWebServer Class)
The pre-shared authentication key.
Syntax
ANSI (Cross Platform) char* GetKeySecret();
int SetKeySecret(const char* lpszKeySecret); Unicode (Windows) LPWSTR GetKeySecret();
INT SetKeySecret(LPCWSTR lpszKeySecret);
char* secureblackbox_dcauthwebserver_getkeysecret(void* lpObj);
int secureblackbox_dcauthwebserver_setkeysecret(void* lpObj, const char* lpszKeySecret);
QString GetKeySecret();
int SetKeySecret(QString qsKeySecret);
Default Value
""
Remarks
If processing requests from a single known party, assign the key you pre-shared with them to this property. Use KeyId property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
Data Type
String
PinnedClient Property (DCAuthWebServer Class)
Populates the pinned client details.
Syntax
SecureBlackboxTLSConnectionInfo* GetPinnedClient();
int secureblackbox_dcauthwebserver_getpinnedclientaeadcipher(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientchainvalidationdetails(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientchainvalidationresult(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientciphersuite(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientclientauthenticated(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientclientauthrequested(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientconnectionestablished(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);
char* secureblackbox_dcauthwebserver_getpinnedclientdigestalgorithm(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientencryptionalgorithm(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientexportable(void* lpObj);
int64 secureblackbox_dcauthwebserver_getpinnedclientid(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientkeyexchangealgorithm(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientkeyexchangekeybits(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientnamedeccurve(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientpfscipher(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientpresharedidentity(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientpresharedidentityhint(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientpublickeybits(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientremoteport(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientresumedsession(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientsecureconnection(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientserverauthenticated(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientsignaturealgorithm(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientsymmetricblocksize(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientsymmetrickeybits(void* lpObj);
int64 secureblackbox_dcauthwebserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_dcauthwebserver_getpinnedclienttotalbytessent(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientvalidationlog(void* lpObj);
char* secureblackbox_dcauthwebserver_getpinnedclientversion(void* lpObj);
bool GetPinnedClientAEADCipher(); int GetPinnedClientChainValidationDetails(); int GetPinnedClientChainValidationResult(); QString GetPinnedClientCiphersuite(); bool GetPinnedClientClientAuthenticated(); bool GetPinnedClientClientAuthRequested(); bool GetPinnedClientConnectionEstablished(); QByteArray GetPinnedClientConnectionID(); QString GetPinnedClientDigestAlgorithm(); QString GetPinnedClientEncryptionAlgorithm(); bool GetPinnedClientExportable(); qint64 GetPinnedClientID(); QString GetPinnedClientKeyExchangeAlgorithm(); int GetPinnedClientKeyExchangeKeyBits(); QString GetPinnedClientNamedECCurve(); bool GetPinnedClientPFSCipher(); QString GetPinnedClientPreSharedIdentity(); QString GetPinnedClientPreSharedIdentityHint(); int GetPinnedClientPublicKeyBits(); QString GetPinnedClientRemoteAddress(); int GetPinnedClientRemotePort(); bool GetPinnedClientResumedSession(); bool GetPinnedClientSecureConnection(); bool GetPinnedClientServerAuthenticated(); QString GetPinnedClientSignatureAlgorithm(); int GetPinnedClientSymmetricBlockSize(); int GetPinnedClientSymmetricKeyBits(); qint64 GetPinnedClientTotalBytesReceived(); qint64 GetPinnedClientTotalBytesSent(); QString GetPinnedClientValidationLog(); QString GetPinnedClientVersion();
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
This property is read-only and not available at design time.
Data Type
SecureBlackboxTLSConnectionInfo
PinnedClientChain Property (DCAuthWebServer Class)
Contains the certificate chain of the pinned client.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();
int secureblackbox_dcauthwebserver_getpinnedclientcertcount(void* lpObj);
int secureblackbox_dcauthwebserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);
int secureblackbox_dcauthwebserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);
char* secureblackbox_dcauthwebserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex);
int64 secureblackbox_dcauthwebserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_dcauthwebserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex);
int secureblackbox_dcauthwebserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);
int secureblackbox_dcauthwebserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);
int secureblackbox_dcauthwebserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);
int secureblackbox_dcauthwebserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);
char* secureblackbox_dcauthwebserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);
int secureblackbox_dcauthwebserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);
char* secureblackbox_dcauthwebserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_dcauthwebserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);
int GetPinnedClientCertCount(); QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex); QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex); qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex); int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex); int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex); bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex); QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex); QString GetPinnedClientCertSubject(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex); QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex); QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex); QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
This property is read-only and not available at design time.
Data Type
Policies Property (DCAuthWebServer Class)
Specifies the policies to use when processing requests.
Syntax
ANSI (Cross Platform) int GetPolicies();
int SetPolicies(int iPolicies); Unicode (Windows) INT GetPolicies();
INT SetPolicies(INT iPolicies);
int secureblackbox_dcauthwebserver_getpolicies(void* lpObj);
int secureblackbox_dcauthwebserver_setpolicies(void* lpObj, int iPolicies);
int GetPolicies();
int SetPolicies(int iPolicies);
Default Value
0
Remarks
This property lets you specify policies to apply blanketly to the requests. If this property does not give you enough flexibility - for example, if you need to cherry-pick requests basing on their content - please consider using the SignRequest (allows you to track individual requests) and/or ExternalSign (lets you perform the signing manually) events. This setting is a bit mask of the following flags:
aspAcceptUnsignedRequests | 1 | Allows the component to accept unauthenticated messages (those not signed with KeyID/KeySecret). Use with extreme care. |
aspIgnorePKCS1Requests | 2 | Ignore requests of PKCS1 type. |
aspIgnorePKCS7Requests | 4 | Ignore requests of PKCS7 type. |
aspIgnoreRequestTSA | 8 | Ignore the TSA URL provided in the request, and either stick with the service provided via TimestampServer property, or not timestamp the message altogether. |
aspIgnoreRequestSigningTime | 16 | Ignore the signing time included in the request. |
aspIgnoreRequestPKCS7Settings | 32 | Ignore auxiliary PKCS7 settings (content type, attributes) included in the request. |
aspAlwaysTimestampSigs | 64 | Timestamp created signatures (PKCS7 only), even if the client did not request it. |
This property is not available at design time.
Data Type
Integer
Port Property (DCAuthWebServer Class)
Specifies the port number to listen for connections on.
Syntax
ANSI (Cross Platform) int GetPort();
int SetPort(int iPort); Unicode (Windows) INT GetPort();
INT SetPort(INT iPort);
int secureblackbox_dcauthwebserver_getport(void* lpObj);
int secureblackbox_dcauthwebserver_setport(void* lpObj, int iPort);
int GetPort();
int SetPort(int iPort);
Default Value
80
Remarks
Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.
Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Data Type
Integer
PortRangeFrom Property (DCAuthWebServer Class)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
ANSI (Cross Platform) int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom); Unicode (Windows) INT GetPortRangeFrom();
INT SetPortRangeFrom(INT iPortRangeFrom);
int secureblackbox_dcauthwebserver_getportrangefrom(void* lpObj);
int secureblackbox_dcauthwebserver_setportrangefrom(void* lpObj, int iPortRangeFrom);
int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom);
Default Value
0
Remarks
Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
Data Type
Integer
PortRangeTo Property (DCAuthWebServer Class)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
ANSI (Cross Platform) int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo); Unicode (Windows) INT GetPortRangeTo();
INT SetPortRangeTo(INT iPortRangeTo);
int secureblackbox_dcauthwebserver_getportrangeto(void* lpObj);
int secureblackbox_dcauthwebserver_setportrangeto(void* lpObj, int iPortRangeTo);
int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo);
Default Value
0
Remarks
Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
Data Type
Integer
SessionTimeout Property (DCAuthWebServer Class)
Specifies the default session timeout value in milliseconds.
Syntax
ANSI (Cross Platform) int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout); Unicode (Windows) INT GetSessionTimeout();
INT SetSessionTimeout(INT iSessionTimeout);
int secureblackbox_dcauthwebserver_getsessiontimeout(void* lpObj);
int secureblackbox_dcauthwebserver_setsessiontimeout(void* lpObj, int iSessionTimeout);
int GetSessionTimeout();
int SetSessionTimeout(int iSessionTimeout);
Default Value
360000
Remarks
Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.
Data Type
Integer
SignEndpoint Property (DCAuthWebServer Class)
The signing service endpoint.
Syntax
ANSI (Cross Platform) char* GetSignEndpoint();
int SetSignEndpoint(const char* lpszSignEndpoint); Unicode (Windows) LPWSTR GetSignEndpoint();
INT SetSignEndpoint(LPCWSTR lpszSignEndpoint);
char* secureblackbox_dcauthwebserver_getsignendpoint(void* lpObj);
int secureblackbox_dcauthwebserver_setsignendpoint(void* lpObj, const char* lpszSignEndpoint);
QString GetSignEndpoint();
int SetSignEndpoint(QString qsSignEndpoint);
Default Value
"/sign"
Remarks
Use this property to specify the signing service end point on the server.
Data Type
String
SigningCertificate Property (DCAuthWebServer Class)
The certificate to be used for signing.
Syntax
SecureBlackboxCertificate* GetSigningCertificate(); int SetSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_dcauthwebserver_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int64 secureblackbox_dcauthwebserver_getsigningcerthandle(void* lpObj);
int secureblackbox_dcauthwebserver_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
QByteArray GetSigningCertBytes(); qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
Data Type
SigningChain Property (DCAuthWebServer Class)
The signing certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain(); int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_dcauthwebserver_getsigningchaincount(void* lpObj);
int secureblackbox_dcauthwebserver_setsigningchaincount(void* lpObj, int iSigningChainCount);
int secureblackbox_dcauthwebserver_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
int64 secureblackbox_dcauthwebserver_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_dcauthwebserver_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); QByteArray GetSigningChainBytes(int iSigningChainIndex); qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Remarks
Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
Data Type
SocketSettings Property (DCAuthWebServer Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_dcauthwebserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_dcauthwebserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_dcauthwebserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_dcauthwebserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_dcauthwebserver_getsocketlocalport(void* lpObj);
int secureblackbox_dcauthwebserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_dcauthwebserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_dcauthwebserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_dcauthwebserver_getsockettimeout(void* lpObj);
int secureblackbox_dcauthwebserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_dcauthwebserver_getsocketuseipv6(void* lpObj);
int secureblackbox_dcauthwebserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
StorageId Property (DCAuthWebServer Class)
Specifies the signing certificate residing in an alternative location.
Syntax
ANSI (Cross Platform) char* GetStorageId();
int SetStorageId(const char* lpszStorageId); Unicode (Windows) LPWSTR GetStorageId();
INT SetStorageId(LPCWSTR lpszStorageId);
char* secureblackbox_dcauthwebserver_getstorageid(void* lpObj);
int secureblackbox_dcauthwebserver_setstorageid(void* lpObj, const char* lpszStorageId);
QString GetStorageId();
int SetStorageId(QString qsStorageId);
Default Value
""
Remarks
Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.
Example 1: The certificate resides on a PKCS#11 device
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1
Example 2: The certificate resides in a system store
system://localmachine@/?store=MY
You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:
- cn: the common name of the certificate subject.
- keyid: the unique identifier included in subject key identifier extension of the certificate.
- keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
- fingerprint: the fingerprint of the certificate.
Example 3: selecting the certificate with a given fingerprint:
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344
Data Type
String
TimestampServer Property (DCAuthWebServer Class)
The address of the timestamping server.
Syntax
ANSI (Cross Platform) char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer); Unicode (Windows) LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);
char* secureblackbox_dcauthwebserver_gettimestampserver(void* lpObj);
int secureblackbox_dcauthwebserver_settimestampserver(void* lpObj, const char* lpszTimestampServer);
QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);
Default Value
""
Remarks
Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.
SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.
If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:
http://user:password@timestamp.server.com/TsaService
For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.
If this property is left empty, no timestamp will be added to the signature.
Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.
To employ the virtual service, assign an URI of the following format to this property:
virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true
Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:
component.Config("TimestampResponse=308208ab...");
Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.
The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.
The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.
The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.
The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.
All the parameters are optional.
Data Type
String
TLSServerChain Property (DCAuthWebServer Class)
The server's TLS certificates.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain(); int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_dcauthwebserver_gettlsservercertcount(void* lpObj);
int secureblackbox_dcauthwebserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);
int secureblackbox_dcauthwebserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int64 secureblackbox_dcauthwebserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_dcauthwebserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);
int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);
Remarks
Use this property to provide a list of TLS certificates for the server endpoint.
A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.
The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.
This property is not available at design time.
Data Type
TLSSettings Property (DCAuthWebServer Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_dcauthwebserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_dcauthwebserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_dcauthwebserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_dcauthwebserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_dcauthwebserver_gettlsciphersuites(void* lpObj);
int secureblackbox_dcauthwebserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_dcauthwebserver_gettlsclientauth(void* lpObj);
int secureblackbox_dcauthwebserver_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_dcauthwebserver_gettlseccurves(void* lpObj);
int secureblackbox_dcauthwebserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_dcauthwebserver_gettlsextensions(void* lpObj);
int secureblackbox_dcauthwebserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_dcauthwebserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_dcauthwebserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_dcauthwebserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_dcauthwebserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_dcauthwebserver_gettlspresharedkey(void* lpObj);
int secureblackbox_dcauthwebserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_dcauthwebserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_dcauthwebserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_dcauthwebserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_dcauthwebserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_dcauthwebserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_dcauthwebserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_dcauthwebserver_gettlsssloptions(void* lpObj);
int secureblackbox_dcauthwebserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_dcauthwebserver_gettlstlsmode(void* lpObj);
int secureblackbox_dcauthwebserver_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_dcauthwebserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_dcauthwebserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_dcauthwebserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_dcauthwebserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_dcauthwebserver_gettlsversions(void* lpObj);
int secureblackbox_dcauthwebserver_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
Users Property (DCAuthWebServer Class)
Provides a list of registered users.
Syntax
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers(); int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
int secureblackbox_dcauthwebserver_getusercount(void* lpObj);
int secureblackbox_dcauthwebserver_setusercount(void* lpObj, int iUserCount);
int secureblackbox_dcauthwebserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_dcauthwebserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_dcauthwebserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
char* secureblackbox_dcauthwebserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
int64 secureblackbox_dcauthwebserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_dcauthwebserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_dcauthwebserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_dcauthwebserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_dcauthwebserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_dcauthwebserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_dcauthwebserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
char* secureblackbox_dcauthwebserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_dcauthwebserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
Remarks
Assign a list of 'known' users to this property to automate authentication handling by the class.
This property is not available at design time.
Data Type
WebsiteName Property (DCAuthWebServer Class)
Specifies the web site name to use in the certificate.
Syntax
ANSI (Cross Platform) char* GetWebsiteName();
int SetWebsiteName(const char* lpszWebsiteName); Unicode (Windows) LPWSTR GetWebsiteName();
INT SetWebsiteName(LPCWSTR lpszWebsiteName);
char* secureblackbox_dcauthwebserver_getwebsitename(void* lpObj);
int secureblackbox_dcauthwebserver_setwebsitename(void* lpObj, const char* lpszWebsiteName);
QString GetWebsiteName();
int SetWebsiteName(QString qsWebsiteName);
Default Value
"secureblackbox"
Remarks
If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.
Data Type
String
Cleanup Method (DCAuthWebServer Class)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
ANSI (Cross Platform) int Cleanup(); Unicode (Windows) INT Cleanup();
int secureblackbox_dcauthwebserver_cleanup(void* lpObj);
int Cleanup();
Remarks
Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (DCAuthWebServer Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_dcauthwebserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (DCAuthWebServer 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_dcauthwebserver_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.
DropClient Method (DCAuthWebServer Class)
Terminates a client connection.
Syntax
ANSI (Cross Platform) int DropClient(int64 lConnectionId, int bForced); Unicode (Windows) INT DropClient(LONG64 lConnectionId, BOOL bForced);
int secureblackbox_dcauthwebserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);
int DropClient(qint64 lConnectionId, bool bForced);
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListClients Method (DCAuthWebServer Class)
Enumerates the connected clients.
Syntax
ANSI (Cross Platform) char* ListClients(); Unicode (Windows) LPWSTR ListClients();
char* secureblackbox_dcauthwebserver_listclients(void* lpObj);
QString ListClients();
Remarks
This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
PinClient Method (DCAuthWebServer Class)
Takes a snapshot of the connection's properties.
Syntax
ANSI (Cross Platform) int PinClient(int64 lConnectionId); Unicode (Windows) INT PinClient(LONG64 lConnectionId);
int secureblackbox_dcauthwebserver_pinclient(void* lpObj, int64 lConnectionId);
int PinClient(qint64 lConnectionId);
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (DCAuthWebServer Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_dcauthwebserver_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.)
Start Method (DCAuthWebServer Class)
Starts the server.
Syntax
ANSI (Cross Platform) int Start(); Unicode (Windows) INT Start();
int secureblackbox_dcauthwebserver_start(void* lpObj);
int Start();
Remarks
Use this method to activate the server and start listening to incoming connections.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Stop Method (DCAuthWebServer Class)
Stops the server.
Syntax
ANSI (Cross Platform) int Stop(); Unicode (Windows) INT Stop();
int secureblackbox_dcauthwebserver_stop(void* lpObj);
int Stop();
Remarks
Call this method to stop listening to incoming connections and deactivate the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Accept Event (DCAuthWebServer Class)
Reports an incoming connection.
Syntax
ANSI (Cross Platform) virtual int FireAccept(DCAuthWebServerAcceptEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
int Accept; int reserved; } DCAuthWebServerAcceptEventParams;
Unicode (Windows) virtual INT FireAccept(DCAuthWebServerAcceptEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
BOOL Accept; INT reserved; } DCAuthWebServerAcceptEventParams;
#define EID_DCAUTHWEBSERVER_ACCEPT 1 virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);
class DCAuthWebServerAcceptEventParams { public: const QString &RemoteAddress(); int RemotePort(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Accept(DCAuthWebServerAcceptEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireAccept(DCAuthWebServerAcceptEventParams *e) {...}
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
AuthAttempt Event (DCAuthWebServer Class)
Fires when a connected client makes an authentication attempt.
Syntax
ANSI (Cross Platform) virtual int FireAuthAttempt(DCAuthWebServerAuthAttemptEventParams *e);
typedef struct {
int64 ConnectionID;
const char *HTTPMethod;
const char *URI;
const char *AuthMethod;
const char *Username;
const char *Password;
int Allow; int reserved; } DCAuthWebServerAuthAttemptEventParams;
Unicode (Windows) virtual INT FireAuthAttempt(DCAuthWebServerAuthAttemptEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR HTTPMethod;
LPCWSTR URI;
LPCWSTR AuthMethod;
LPCWSTR Username;
LPCWSTR Password;
BOOL Allow; INT reserved; } DCAuthWebServerAuthAttemptEventParams;
#define EID_DCAUTHWEBSERVER_AUTHATTEMPT 2 virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURI, LPSTR &lpszAuthMethod, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAllow);
class DCAuthWebServerAuthAttemptEventParams { public: qint64 ConnectionID(); const QString &HTTPMethod(); const QString &URI(); const QString &AuthMethod(); const QString &Username(); const QString &Password(); bool Allow(); void SetAllow(bool bAllow); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AuthAttempt(DCAuthWebServerAuthAttemptEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireAuthAttempt(DCAuthWebServerAuthAttemptEventParams *e) {...}
Remarks
The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.
ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.
Connect Event (DCAuthWebServer Class)
Reports an accepted connection.
Syntax
ANSI (Cross Platform) virtual int FireConnect(DCAuthWebServerConnectEventParams *e);
typedef struct {
int64 ConnectionID;
const char *RemoteAddress;
int RemotePort; int reserved; } DCAuthWebServerConnectEventParams;
Unicode (Windows) virtual INT FireConnect(DCAuthWebServerConnectEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR RemoteAddress;
INT RemotePort; INT reserved; } DCAuthWebServerConnectEventParams;
#define EID_DCAUTHWEBSERVER_CONNECT 3 virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionID, LPSTR &lpszRemoteAddress, INT &iRemotePort);
class DCAuthWebServerConnectEventParams { public: qint64 ConnectionID(); const QString &RemoteAddress(); int RemotePort(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connect(DCAuthWebServerConnectEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireConnect(DCAuthWebServerConnectEventParams *e) {...}
Remarks
The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as TLSHandshake or Data.
CustomParametersReceived Event (DCAuthWebServer Class)
Passes custom request parameters to the application.
Syntax
ANSI (Cross Platform) virtual int FireCustomParametersReceived(DCAuthWebServerCustomParametersReceivedEventParams *e);
typedef struct {
int64 ConnectionId;
const char *Value; int reserved; } DCAuthWebServerCustomParametersReceivedEventParams;
Unicode (Windows) virtual INT FireCustomParametersReceived(DCAuthWebServerCustomParametersReceivedEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR Value; INT reserved; } DCAuthWebServerCustomParametersReceivedEventParams;
#define EID_DCAUTHWEBSERVER_CUSTOMPARAMETERSRECEIVED 4 virtual INT SECUREBLACKBOX_CALL FireCustomParametersReceived(LONG64 &lConnectionId, LPSTR &lpszValue);
class DCAuthWebServerCustomParametersReceivedEventParams { public: qint64 ConnectionId(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CustomParametersReceived(DCAuthWebServerCustomParametersReceivedEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireCustomParametersReceived(DCAuthWebServerCustomParametersReceivedEventParams *e) {...}
Remarks
Subscribe to this event to access custom signing parameters supplied by the signer in their request. The Value string contains the parameters as included by the requestor.
Disconnect Event (DCAuthWebServer Class)
Fires to report a disconnected client.
Syntax
ANSI (Cross Platform) virtual int FireDisconnect(DCAuthWebServerDisconnectEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } DCAuthWebServerDisconnectEventParams;
Unicode (Windows) virtual INT FireDisconnect(DCAuthWebServerDisconnectEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } DCAuthWebServerDisconnectEventParams;
#define EID_DCAUTHWEBSERVER_DISCONNECT 5 virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);
class DCAuthWebServerDisconnectEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnect(DCAuthWebServerDisconnectEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireDisconnect(DCAuthWebServerDisconnectEventParams *e) {...}
Remarks
The class fires this event when a connected client disconnects.
Error Event (DCAuthWebServer Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(DCAuthWebServerErrorEventParams *e);
typedef struct {
int64 ConnectionID;
int ErrorCode;
int Fatal;
int Remote;
const char *Description; int reserved; } DCAuthWebServerErrorEventParams;
Unicode (Windows) virtual INT FireError(DCAuthWebServerErrorEventParams *e);
typedef struct {
LONG64 ConnectionID;
INT ErrorCode;
BOOL Fatal;
BOOL Remote;
LPCWSTR Description; INT reserved; } DCAuthWebServerErrorEventParams;
#define EID_DCAUTHWEBSERVER_ERROR 6 virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);
class DCAuthWebServerErrorEventParams { public: qint64 ConnectionID(); int ErrorCode(); bool Fatal(); bool Remote(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(DCAuthWebServerErrorEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireError(DCAuthWebServerErrorEventParams *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 (DCAuthWebServer Class)
Handles remote or external signing initiated by the server protocol.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(DCAuthWebServerExternalSignEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } DCAuthWebServerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(DCAuthWebServerExternalSignEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } DCAuthWebServerExternalSignEventParams;
#define EID_DCAUTHWEBSERVER_EXTERNALSIGN 7 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class DCAuthWebServerExternalSignEventParams { public: qint64 ConnectionID(); const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(DCAuthWebServerExternalSignEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireExternalSign(DCAuthWebServerExternalSignEventParams *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();
};
KeySecretNeeded Event (DCAuthWebServer Class)
Requests the key secret from the application.
Syntax
ANSI (Cross Platform) virtual int FireKeySecretNeeded(DCAuthWebServerKeySecretNeededEventParams *e);
typedef struct {
int64 ConnectionId;
const char *KeyId;
char *KeySecret; int reserved; } DCAuthWebServerKeySecretNeededEventParams;
Unicode (Windows) virtual INT FireKeySecretNeeded(DCAuthWebServerKeySecretNeededEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR KeyId;
LPWSTR KeySecret; INT reserved; } DCAuthWebServerKeySecretNeededEventParams;
#define EID_DCAUTHWEBSERVER_KEYSECRETNEEDED 8 virtual INT SECUREBLACKBOX_CALL FireKeySecretNeeded(LONG64 &lConnectionId, LPSTR &lpszKeyId, LPSTR &lpszKeySecret);
class DCAuthWebServerKeySecretNeededEventParams { public: qint64 ConnectionId(); const QString &KeyId(); const QString &KeySecret(); void SetKeySecret(const QString &qsKeySecret); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeySecretNeeded(DCAuthWebServerKeySecretNeededEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireKeySecretNeeded(DCAuthWebServerKeySecretNeededEventParams *e) {...}
Remarks
Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the KeyId, a non-secret unique key identifier, and the KeySecret, shared by the parties, which should be kept private. This event is an alternative for KeySecret property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via KeyId and KeySecret properties would be an easier route.
Log Event (DCAuthWebServer Class)
Reports a single log line.
Syntax
ANSI (Cross Platform) virtual int FireLog(DCAuthWebServerLogEventParams *e);
typedef struct {
int64 ConnectionId;
int LogType;
const char *Details; int reserved; } DCAuthWebServerLogEventParams;
Unicode (Windows) virtual INT FireLog(DCAuthWebServerLogEventParams *e);
typedef struct {
LONG64 ConnectionId;
INT LogType;
LPCWSTR Details; INT reserved; } DCAuthWebServerLogEventParams;
#define EID_DCAUTHWEBSERVER_LOG 9 virtual INT SECUREBLACKBOX_CALL FireLog(LONG64 &lConnectionId, INT &iLogType, LPSTR &lpszDetails);
class DCAuthWebServerLogEventParams { public: qint64 ConnectionId(); int LogType(); const QString &Details(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(DCAuthWebServerLogEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireLog(DCAuthWebServerLogEventParams *e) {...}
Remarks
This event is fired repeatedly during the component's work to inform the application about the flow of the signing process. The application may use this event to create an operation log.
Notification Event (DCAuthWebServer Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(DCAuthWebServerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } DCAuthWebServerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(DCAuthWebServerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } DCAuthWebServerNotificationEventParams;
#define EID_DCAUTHWEBSERVER_NOTIFICATION 10 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class DCAuthWebServerNotificationEventParams { 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(DCAuthWebServerNotificationEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireNotification(DCAuthWebServerNotificationEventParams *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.
ParameterReceived Event (DCAuthWebServer Class)
Passes a standard request parameter to the user code.
Syntax
ANSI (Cross Platform) virtual int FireParameterReceived(DCAuthWebServerParameterReceivedEventParams *e);
typedef struct {
int64 ConnectionId;
const char *Name;
const char *Value; int reserved; } DCAuthWebServerParameterReceivedEventParams;
Unicode (Windows) virtual INT FireParameterReceived(DCAuthWebServerParameterReceivedEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR Name;
LPCWSTR Value; INT reserved; } DCAuthWebServerParameterReceivedEventParams;
#define EID_DCAUTHWEBSERVER_PARAMETERRECEIVED 11 virtual INT SECUREBLACKBOX_CALL FireParameterReceived(LONG64 &lConnectionId, LPSTR &lpszName, LPSTR &lpszValue);
class DCAuthWebServerParameterReceivedEventParams { public: qint64 ConnectionId(); const QString &Name(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ParameterReceived(DCAuthWebServerParameterReceivedEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireParameterReceived(DCAuthWebServerParameterReceivedEventParams *e) {...}
Remarks
This event is fired when one of 'standard' protocol parameters has been found in the request:
- SessionID
- DataURL
- GoURL
- Token
- PKCS11Libraries
- AllowFileStorage
- AllowTokenStorage
- AllowWindowsStorage
- AllowOSStorage
PasswordNeeded Event (DCAuthWebServer Class)
Requests a password from the application.
Syntax
ANSI (Cross Platform) virtual int FirePasswordNeeded(DCAuthWebServerPasswordNeededEventParams *e);
typedef struct {
const char *NeededFor;
const char *Id;
char *Password;
int Cancel; int reserved; } DCAuthWebServerPasswordNeededEventParams;
Unicode (Windows) virtual INT FirePasswordNeeded(DCAuthWebServerPasswordNeededEventParams *e);
typedef struct {
LPCWSTR NeededFor;
LPCWSTR Id;
LPWSTR Password;
BOOL Cancel; INT reserved; } DCAuthWebServerPasswordNeededEventParams;
#define EID_DCAUTHWEBSERVER_PASSWORDNEEDED 12 virtual INT SECUREBLACKBOX_CALL FirePasswordNeeded(LPSTR &lpszNeededFor, LPSTR &lpszId, LPSTR &lpszPassword, BOOL &bCancel);
class DCAuthWebServerPasswordNeededEventParams { public: const QString &NeededFor(); const QString &Id(); const QString &Password(); void SetPassword(const QString &qsPassword); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void PasswordNeeded(DCAuthWebServerPasswordNeededEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FirePasswordNeeded(DCAuthWebServerPasswordNeededEventParams *e) {...}
Remarks
Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.
ReadOption Event (DCAuthWebServer Class)
Fires when the client sends in a read option request.
Syntax
ANSI (Cross Platform) virtual int FireReadOption(DCAuthWebServerReadOptionEventParams *e);
typedef struct {
int64 ConnectionId;
const char *Name;
char *Value;
int Success; int reserved; } DCAuthWebServerReadOptionEventParams;
Unicode (Windows) virtual INT FireReadOption(DCAuthWebServerReadOptionEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR Name;
LPWSTR Value;
BOOL Success; INT reserved; } DCAuthWebServerReadOptionEventParams;
#define EID_DCAUTHWEBSERVER_READOPTION 13 virtual INT SECUREBLACKBOX_CALL FireReadOption(LONG64 &lConnectionId, LPSTR &lpszName, LPSTR &lpszValue, BOOL &bSuccess);
class DCAuthWebServerReadOptionEventParams { public: qint64 ConnectionId(); const QString &Name(); const QString &Value(); void SetValue(const QString &qsValue); bool Success(); void SetSuccess(bool bSuccess); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadOption(DCAuthWebServerReadOptionEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireReadOption(DCAuthWebServerReadOptionEventParams *e) {...}
Remarks
Subscribe to this event to respond to the clients' read option requests. The handler should retrieve the value of the requested option from a local configuration setting and assign it to the Value parameter.
SelectCert Event (DCAuthWebServer Class)
Requests certificate selection criteria from the application.
Syntax
ANSI (Cross Platform) virtual int FireSelectCert(DCAuthWebServerSelectCertEventParams *e);
typedef struct {
int64 ConnectionId;
char *CommonName;
char *KeyID;
char *KeyUsage;
char *Fingerprint;
char *StoreType; int reserved; } DCAuthWebServerSelectCertEventParams;
Unicode (Windows) virtual INT FireSelectCert(DCAuthWebServerSelectCertEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPWSTR CommonName;
LPWSTR KeyID;
LPWSTR KeyUsage;
LPWSTR Fingerprint;
LPWSTR StoreType; INT reserved; } DCAuthWebServerSelectCertEventParams;
#define EID_DCAUTHWEBSERVER_SELECTCERT 14 virtual INT SECUREBLACKBOX_CALL FireSelectCert(LONG64 &lConnectionId, LPSTR &lpszCommonName, LPSTR &lpszKeyID, LPSTR &lpszKeyUsage, LPSTR &lpszFingerprint, LPSTR &lpszStoreType);
class DCAuthWebServerSelectCertEventParams { public: qint64 ConnectionId(); const QString &CommonName(); void SetCommonName(const QString &qsCommonName); const QString &KeyID(); void SetKeyID(const QString &qsKeyID); const QString &KeyUsage(); void SetKeyUsage(const QString &qsKeyUsage); const QString &Fingerprint(); void SetFingerprint(const QString &qsFingerprint); const QString &StoreType(); void SetStoreType(const QString &qsStoreType); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SelectCert(DCAuthWebServerSelectCertEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireSelectCert(DCAuthWebServerSelectCertEventParams *e) {...}
Remarks
Subscribe to this event to provide signing certificate details on the fly, right before the hash is signed.
SignRequest Event (DCAuthWebServer Class)
This event signifies the processing of an atomic signing request.
Syntax
ANSI (Cross Platform) virtual int FireSignRequest(DCAuthWebServerSignRequestEventParams *e);
typedef struct {
int64 ConnectionId;
int Method;
const char *HashAlgorithm;
const char *Hash; int lenHash;
const char *KeyID;
const char *Pars;
const char *MethodPars;
int Allow; int reserved; } DCAuthWebServerSignRequestEventParams;
Unicode (Windows) virtual INT FireSignRequest(DCAuthWebServerSignRequestEventParams *e);
typedef struct {
LONG64 ConnectionId;
INT Method;
LPCWSTR HashAlgorithm;
LPCSTR Hash; INT lenHash;
LPCWSTR KeyID;
LPCWSTR Pars;
LPCWSTR MethodPars;
BOOL Allow; INT reserved; } DCAuthWebServerSignRequestEventParams;
#define EID_DCAUTHWEBSERVER_SIGNREQUEST 15 virtual INT SECUREBLACKBOX_CALL FireSignRequest(LONG64 &lConnectionId, INT &iMethod, LPSTR &lpszHashAlgorithm, LPSTR &lpHash, INT &lenHash, LPSTR &lpszKeyID, LPSTR &lpszPars, LPSTR &lpszMethodPars, BOOL &bAllow);
class DCAuthWebServerSignRequestEventParams { public: qint64 ConnectionId(); int Method(); const QString &HashAlgorithm(); const QByteArray &Hash(); const QString &KeyID(); const QString &Pars(); const QString &MethodPars(); bool Allow(); void SetAllow(bool bAllow); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignRequest(DCAuthWebServerSignRequestEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireSignRequest(DCAuthWebServerSignRequestEventParams *e) {...}
Remarks
Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The Method parameter specifies the async signing method requested by the client:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
The Hash parameter contains the hash, made using HashAlgorithm, that needs to be signed. KeyID contains the key identifier of the requestor.
The Pars string contains a semicolon-separated string of the principal signature parameters. This has the same format and content that is passed to ExternalSign, if it is used. The MethodPars contains a similar parameter string, but for the specific async signing method used. For the PKCS1 method there are no defined method parameters, while the PKCS7 method supports a selection of settings that tune up the CMS blob.
Set Allow to false to reject the request. Use the SignRequestCompleted event to track completion of the initiated operation.
SignRequestCompleted Event (DCAuthWebServer Class)
This event signifies completion of the processing of an atomic signing request.
Syntax
ANSI (Cross Platform) virtual int FireSignRequestCompleted(DCAuthWebServerSignRequestCompletedEventParams *e);
typedef struct {
int64 ConnectionId;
int Method;
const char *HashAlgorithm;
const char *Hash; int lenHash;
const char *KeyID;
const char *Pars;
const char *MethodPars;
const char *Signature; int lenSignature; int reserved; } DCAuthWebServerSignRequestCompletedEventParams;
Unicode (Windows) virtual INT FireSignRequestCompleted(DCAuthWebServerSignRequestCompletedEventParams *e);
typedef struct {
LONG64 ConnectionId;
INT Method;
LPCWSTR HashAlgorithm;
LPCSTR Hash; INT lenHash;
LPCWSTR KeyID;
LPCWSTR Pars;
LPCWSTR MethodPars;
LPCSTR Signature; INT lenSignature; INT reserved; } DCAuthWebServerSignRequestCompletedEventParams;
#define EID_DCAUTHWEBSERVER_SIGNREQUESTCOMPLETED 16 virtual INT SECUREBLACKBOX_CALL FireSignRequestCompleted(LONG64 &lConnectionId, INT &iMethod, LPSTR &lpszHashAlgorithm, LPSTR &lpHash, INT &lenHash, LPSTR &lpszKeyID, LPSTR &lpszPars, LPSTR &lpszMethodPars, LPSTR &lpSignature, INT &lenSignature);
class DCAuthWebServerSignRequestCompletedEventParams { public: qint64 ConnectionId(); int Method(); const QString &HashAlgorithm(); const QByteArray &Hash(); const QString &KeyID(); const QString &Pars(); const QString &MethodPars(); const QByteArray &Signature(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignRequestCompleted(DCAuthWebServerSignRequestCompletedEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireSignRequestCompleted(DCAuthWebServerSignRequestCompletedEventParams *e) {...}
Remarks
Use this event to track completion of signing request processing. The Hash parameter contains the hash that is signed, as supplied by the requestor, and the Signature parameter contains the resulting cryptographic signature. The Username parameter matches the parameter in SignRequest event.
TimestampRequest Event (DCAuthWebServer Class)
Fires when the class is ready to request a timestamp from an external TSA.
Syntax
ANSI (Cross Platform) virtual int FireTimestampRequest(DCAuthWebServerTimestampRequestEventParams *e);
typedef struct {
const char *TSA;
const char *TimestampRequest;
char *TimestampResponse;
int SuppressDefault; int reserved; } DCAuthWebServerTimestampRequestEventParams;
Unicode (Windows) virtual INT FireTimestampRequest(DCAuthWebServerTimestampRequestEventParams *e);
typedef struct {
LPCWSTR TSA;
LPCWSTR TimestampRequest;
LPWSTR TimestampResponse;
BOOL SuppressDefault; INT reserved; } DCAuthWebServerTimestampRequestEventParams;
#define EID_DCAUTHWEBSERVER_TIMESTAMPREQUEST 17 virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);
class DCAuthWebServerTimestampRequestEventParams { public: const QString &TSA(); const QString &TimestampRequest(); const QString &TimestampResponse(); void SetTimestampResponse(const QString &qsTimestampResponse); bool SuppressDefault(); void SetSuppressDefault(bool bSuppressDefault); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampRequest(DCAuthWebServerTimestampRequestEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTimestampRequest(DCAuthWebServerTimestampRequestEventParams *e) {...}
Remarks
Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.
The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.
TLSCertValidate Event (DCAuthWebServer Class)
Fires when a client certificate needs to be validated.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(DCAuthWebServerTLSCertValidateEventParams *e);
typedef struct {
int64 ConnectionID;
int Accept; int reserved; } DCAuthWebServerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(DCAuthWebServerTLSCertValidateEventParams *e);
typedef struct {
LONG64 ConnectionID;
BOOL Accept; INT reserved; } DCAuthWebServerTLSCertValidateEventParams;
#define EID_DCAUTHWEBSERVER_TLSCERTVALIDATE 18 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);
class DCAuthWebServerTLSCertValidateEventParams { public: qint64 ConnectionID(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(DCAuthWebServerTLSCertValidateEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTLSCertValidate(DCAuthWebServerTLSCertValidateEventParams *e) {...}
Remarks
The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (DCAuthWebServer Class)
Reports the setup of a TLS session.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(DCAuthWebServerTLSEstablishedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } DCAuthWebServerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(DCAuthWebServerTLSEstablishedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } DCAuthWebServerTLSEstablishedEventParams;
#define EID_DCAUTHWEBSERVER_TLSESTABLISHED 19 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);
class DCAuthWebServerTLSEstablishedEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(DCAuthWebServerTLSEstablishedEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTLSEstablished(DCAuthWebServerTLSEstablishedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (DCAuthWebServer Class)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(DCAuthWebServerTLSHandshakeEventParams *e);
typedef struct {
int64 ConnectionID;
const char *ServerName;
int Abort; int reserved; } DCAuthWebServerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(DCAuthWebServerTLSHandshakeEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR ServerName;
BOOL Abort; INT reserved; } DCAuthWebServerTLSHandshakeEventParams;
#define EID_DCAUTHWEBSERVER_TLSHANDSHAKE 20 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);
class DCAuthWebServerTLSHandshakeEventParams { public: qint64 ConnectionID(); const QString &ServerName(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(DCAuthWebServerTLSHandshakeEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTLSHandshake(DCAuthWebServerTLSHandshakeEventParams *e) {...}
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (DCAuthWebServer Class)
Requests a pre-shared key for TLS-PSK.
Syntax
ANSI (Cross Platform) virtual int FireTLSPSK(DCAuthWebServerTLSPSKEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Identity;
char *PSK;
char *Ciphersuite; int reserved; } DCAuthWebServerTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(DCAuthWebServerTLSPSKEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Identity;
LPWSTR PSK;
LPWSTR Ciphersuite; INT reserved; } DCAuthWebServerTLSPSKEventParams;
#define EID_DCAUTHWEBSERVER_TLSPSK 21 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);
class DCAuthWebServerTLSPSKEventParams { public: qint64 ConnectionID(); const QString &Identity(); const QString &PSK(); void SetPSK(const QString &qsPSK); const QString &Ciphersuite(); void SetCiphersuite(const QString &qsCiphersuite); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(DCAuthWebServerTLSPSKEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTLSPSK(DCAuthWebServerTLSPSKEventParams *e) {...}
Remarks
The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (DCAuthWebServer Class)
Reports closure of a TLS session.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(DCAuthWebServerTLSShutdownEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } DCAuthWebServerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(DCAuthWebServerTLSShutdownEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } DCAuthWebServerTLSShutdownEventParams;
#define EID_DCAUTHWEBSERVER_TLSSHUTDOWN 22 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);
class DCAuthWebServerTLSShutdownEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(DCAuthWebServerTLSShutdownEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireTLSShutdown(DCAuthWebServerTLSShutdownEventParams *e) {...}
Remarks
The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
WriteOption Event (DCAuthWebServer Class)
Fires when the client sends in a write option request.
Syntax
ANSI (Cross Platform) virtual int FireWriteOption(DCAuthWebServerWriteOptionEventParams *e);
typedef struct {
int64 ConnectionId;
const char *Name;
const char *Value; int reserved; } DCAuthWebServerWriteOptionEventParams;
Unicode (Windows) virtual INT FireWriteOption(DCAuthWebServerWriteOptionEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR Name;
LPCWSTR Value; INT reserved; } DCAuthWebServerWriteOptionEventParams;
#define EID_DCAUTHWEBSERVER_WRITEOPTION 23 virtual INT SECUREBLACKBOX_CALL FireWriteOption(LONG64 &lConnectionId, LPSTR &lpszName, LPSTR &lpszValue);
class DCAuthWebServerWriteOptionEventParams { public: qint64 ConnectionId(); const QString &Name(); const QString &Value(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void WriteOption(DCAuthWebServerWriteOptionEventParams *e);
// Or, subclass DCAuthWebServer and override this emitter function. virtual int FireWriteOption(DCAuthWebServerWriteOptionEventParams *e) {...}
Remarks
Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.
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.
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.
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.
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.
UserAccount Type
A container for user account information.
Syntax
SecureBlackboxUserAccount (declared in secureblackbox.h)
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
AssociatedData
char*
Default Value:
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
BasePath
char*
Default Value: ""
Base path for this user in the server's file system.
Certificate
char*
Default Value:
Contains the user's certificate.
Data
char*
Default Value: ""
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Email
char*
Default Value: ""
The user's email address.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
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: ""
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
IncomingSpeedLimit
int
Default Value: 0
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
OtpAlgorithm
int
Default Value: 0
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
OTPLen
int
Default Value: 0
Specifies the length of the user's OTP password.
OtpValue
int
Default Value: 0
The user's time interval (TOTP) or Counter (HOTP).
OutgoingSpeedLimit
int
Default Value: 0
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
Password
char*
Default Value: ""
The user's authentication password.
SharedSecret
char*
Default Value:
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
SSHKey
char*
Default Value:
Contains the user's SSH key.
Username
char*
Default Value: ""
The registered name (login) of the user.
Constructors
UserAccount()
Creates a new UserAccount object
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the DCAuthWebServer 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) {}
|
Config Settings (DCAuthWebServer 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.DCAuthWebServer Config Settings
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
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 (DCAuthWebServer 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.