SecureBlackbox 2020 macOS Edition

Questions / Feedback?

OCSPServer Module

Properties   Methods   Events   Configuration Settings   Errors  

The OCSPServer component provides the functionality of an HTTP-based OCSP server.

Syntax

nsoftware.SecureBlackbox.Ocspserver

Remarks

Use this class to quickly set up a working HTTP-based OCSP server.

Property List


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

ActiveIndicates whether the server is active and is listening to new connections.
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.
BadEntriesContains a list of revoked certificate entries.
BoundPortIndicates the bound listening port.
CACertificateThe CA certificate.
EndpointThe virtual path that the server recognizes as the OCSP serving endpoint.
ErrorOriginIndicates the endpoint where the error originates from.
ErrorSeverityThe severity of the error that happened.
ExternalCryptoProvides access to external signing and DC parameters.
GoodEntriesContains a list of valid and active certificate entries.
HostThe host to bind the listening port to.
PinnedCertsA collection of certificates to be imported.
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.
SigningCertificateThe certificate to use for signing.
SocketSettingsManages network connection settings.
TLSSettingsManages TLS layer settings.
UpdatePeriodThe server's information update period.
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 module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DropClientTerminates a client connection.
GetRequestBytesReturns the contents of the client's HTTP request.
GetRequestHeaderReturns a request header value.
GetRequestUsernameReturns the username for a connection.
ImportBadCertificatesImports revoked certificates.
ImportGoodCertificatesImports good certificates.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
ProcessGenericRequestProcesses a generic OCSP status request.
StartStarts the server.
StopStops the server.

Event List


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

AcceptReports an incoming connection.
AuthAttemptFires when a connected client makes an authentication attempt.
CertificateValidateFires when a client certificate needs to be validated.
ConnectReports an accepted connection.
DisconnectFires to report a disconnected client.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
NotificationThis event notifies the application about an underlying control flow event.
StatusRequestRequests a certificate status from the application.
TLSEstablishedReports the setup of a TLS session.
TLSPSKRequests a pre-shared key for TLS-PSK.
TLSShutdownReports closure of a TLS session.

Configuration Settings


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

AllowOptionsResponseWithoutAuthEnables unauthenticated responses to OPTIONS requests.
ClientAuthEnables or disables certificate-based client authentication.
DualStackAllows the use of ip4 and ip6 simultaneously.
HomePageSpecifies the home page resource name.
HostThe host to bind to.
RequestFilterThe request string modifier.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
TLSExtensionsProvides access to TLS extensions.
WebsiteNameThe website name for the TLS certificate.
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 macOS Edition - Version 20.0 [Build 8165]