OCSPServer Component
Properties Methods Events Configuration Settings Errors
The OCSPServer component provides the functionality of an HTTP-based OCSP server.
Syntax
TsbxOCSPServer
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 component with short descriptions. Click on the links for further details.
Active | Indicates whether the server is active and is listening to new connections. |
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. |
BadEntries | Contains a list of revoked certificate entries. |
BoundPort | Indicates the bound listening port. |
CACertificate | The CA certificate. |
Endpoint | The virtual path that the server recognizes as the OCSP serving endpoint. |
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. |
GoodEntries | Contains a list of valid and active certificate entries. |
Host | The host to bind the listening port to. |
PinnedCerts | A collection of certificates to be imported. |
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. |
SigningCertificate | The certificate to use for signing. |
SocketSettings | Manages network connection settings. |
TLSSettings | Manages TLS layer settings. |
UpdatePeriod | The server's information update period. |
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. |
GetRequestBytes | Returns the contents of the client's HTTP request. |
GetRequestHeader | Returns a request header value. |
GetRequestUsername | Returns the username for a connection. |
ImportBadCertificates | Imports revoked certificates. |
ImportGoodCertificates | Imports good certificates. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessGenericRequest | Processes a generic OCSP status request. |
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. |
CertificateValidate | Fires when a client certificate needs to be validated. |
Connect | Reports an accepted connection. |
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. |
Notification | This event notifies the application about an underlying control flow event. |
StatusRequest | Requests a certificate status from the application. |
TLSEstablished | Reports the setup of a TLS session. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
ClientAuth | Enables or disables certificate-based client authentication. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HomePage | Specifies the home page resource name. |
Host | The host to bind to. |
RequestFilter | The request string modifier. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
TLSExtensions | Provides access to TLS extensions. |
WebsiteName | The website name for the TLS certificate. |
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. |