SecureBlackbox 2020 Delphi Edition

Questions / Feedback?

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

TsbxDCAuthWebServer

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.

ActiveIndicates whether the server is active and is listening to new connections.
AllowOriginSpecifies the content of AllowOrigin header of the service reply.
AuthBasicEnables or disables basic authentication.
AuthDigestEnables or disables digest authentication.
AuthDigestExpireSpecifies digest expiration time for digest authentication.
AuthRealmSpecifies authentication realm for digest and NTLM authentication.
BoundPortIndicates the bound listening port.
CertPasswordSpecifies the signing certificate password.
ErrorOriginIndicates the endpoint where the error originates from.
ErrorSeverityThe severity of the error that happened.
ExternalCryptoProvides access to external signing and DC parameters.
HandshakeTimeoutSpecifies the handshake timeout in milliseconds.
HostThe host to bind the listening port to.
KeyIdSpecifies the KeyID of the pre-shared authentication key.
KeySecretThe pre-shared authentication key.
PinnedClientPopulates the pinned client details.
PinnedClientChainContains the certificate chain of the pinned client.
PortSpecifies the port number to listen for connections on.
PortRangeFromSpecifies the lower limit of the listening port range for incoming connections.
PortRangeToSpecifies the upper limit of the listening port range for incoming connections.
ServerCertificatesThe server's TLS certificates.
SessionTimeoutSpecifies the default session timeout value in milliseconds.
SignEndpointThe signing service endpoint.
SigningCertificateSpecifies the signing certificate.
SocketSettingsManages network connection settings.
StorageIdSpecifies the signing certificate residing in an alternative location.
TLSSettingsManages TLS layer settings.
UsersProvides a list of registered users.
UseTLSEnables or disables the TLS requirement.
WebsiteNameSpecifies 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.

ConfigSets or retrieves a configuration setting.
DropClientTerminates a client connection.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
StartStarts the server.
StopStops 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.

AcceptReports an incoming connection.
AuthAttemptFires when a connected client makes an authentication attempt.
BeforeOpenStorageInforms about imminent access to the certificate storage.
CertificateValidateFires when a client certificate needs to be validated.
ConnectReports an accepted connection.
CustomParametersReceivedPasses custom request parameters to the application.
DisconnectFires to report a disconnected client.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
KeySecretNeededRequests the key secret from the application.
LogReports a single log line.
NotificationThis event notifies the application about an underlying control flow event.
ParameterReceivedPasses a standard request parameter to the user code.
PasswordNeededRequests a password from the application.
ReadOptionFires when the client sends in a read option request.
SelectCertRequests certificate selection criteria from the application.
SignRequestThis event signifies the processing of an atomic signing request.
SignRequestCompletedThis event signifies completion of the processing of an atomic signing request.
TLSEstablishedReports the setup of a TLS session.
TLSPSKRequests a pre-shared key for TLS-PSK.
TLSShutdownReports closure of a TLS session.
WriteOptionFires 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.

CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Delphi Edition - Version 20.0 [Build 8166]