DCAuthWebServer Component
Properties Methods Events Configuration Settings Errors
The DCAuthWebServer Component offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.
Syntax
SecureBlackbox.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 component 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. |
AuthBasic | Enables or disables basic authentication. |
AuthDigest | Enables or disables digest authentication. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
BoundPort | Indicates the bound listening port. |
CertPassword | Specifies the signing certificate password. |
ErrorOrigin | Indicates the endpoint where the error originates from. |
ErrorSeverity | The severity of the error that happened. |
ExternalCrypto | Provides access to external signing and DC parameters. |
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. |
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. |
ServerCertificates | The server's TLS certificates. |
SessionTimeout | Specifies the default session timeout value in milliseconds. |
SignEndpoint | The signing service endpoint. |
SigningCertificate | Specifies the signing certificate. |
SocketSettings | Manages network connection settings. |
StorageId | Specifies the signing certificate residing in an alternative location. |
TLSSettings | Manages TLS layer settings. |
Users | Provides a list of registered users. |
UseTLS | Enables or disables the TLS requirement. |
WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
dropClient | Terminates a client connection. |
listClients | Enumerates the connected clients. |
pinClient | Takes a snapshot of the connection's properties. |
start | Starts the server. |
stop | Stops the server. |
Event List
The following is the full list of the events fired by the component 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. |
BeforeOpenStorage | Informs about imminent access to the certificate storage. |
CertificateValidate | Fires when a client certificate needs to be validated. |
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. |
TLSEstablished | Reports the setup of a TLS session. |
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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
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 component (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |