OCSPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 class with short descriptions. Click on the links for further details.

Method List

---

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

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.

Config Settings

---

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

Active Property (OCSPServer Class)

Indicates whether the server is active and is listening to new connections.

Syntax

public boolean isActive();

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.

AuthBasic Property (OCSPServer Class)

Enables or disables basic authentication.

Syntax

public boolean isAuthBasic();


public void setAuthBasic(boolean authBasic);

Default Value

False

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

AuthDigest Property (OCSPServer Class)

Enables or disables digest authentication.

Syntax

public boolean isAuthDigest();


public void setAuthDigest(boolean authDigest);

Default Value

False

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

AuthDigestExpire Property (OCSPServer Class)

Specifies digest expiration time for digest authentication.

Syntax

public int getAuthDigestExpire();


public void setAuthDigestExpire(int authDigestExpire);

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds.

AuthRealm Property (OCSPServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

public String getAuthRealm();


public void setAuthRealm(String authRealm);

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

BadEntries Property (OCSPServer Class)

Contains a list of revoked certificate entries.

Syntax

public CRLEntryInfoList getBadEntries();


public void setBadEntries(CRLEntryInfoList badEntries);

Remarks

This collection contains a list of revoked certificate identifiers. Add them manually, or use ImportBadCertificates method to create them from a collection of certificates.

This property is not available at design time.

Please refer to the CRLEntryInfo type for a complete list of fields.

BoundPort Property (OCSPServer Class)

Indicates the bound listening port.

Syntax

public 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.

CACertificate Property (OCSPServer Class)

The CA certificate.

Syntax

public Certificate getCACertificate();


public void setCACertificate(Certificate CACertificate);

Remarks

Use this property to provide the CA certificate that this OCSP server is providing status responses for.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ClientAuth Property (OCSPServer Class)

Enables or disables certificate-based client authentication.

Syntax

public int getClientAuth();


public void setClientAuth(int clientAuth);


Enumerated values:
  public final static int ccatNoAuth = 0;
  public final static int ccatRequestCert = 1;
  public final static int ccatRequireCert = 2;

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

Endpoint Property (OCSPServer Class)

The virtual path that the server recognizes as the OCSP serving endpoint.

Syntax

public String getEndpoint();


public void setEndpoint(String endpoint);

Default Value

"/"

Remarks

Specifies the virtual path that the server serves OCSP responses on.

ErrorOrigin Property (OCSPServer Class)

Indicates the endpoint where the error originates from.

Syntax

public int getErrorOrigin();


public void setErrorOrigin(int errorOrigin);


Enumerated values:
  public final static int eoLocal = 0;
  public final static int eoRemote = 1;

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

ErrorSeverity Property (OCSPServer Class)

The severity of the error that happened.

Syntax

public int getErrorSeverity();


public void setErrorSeverity(int errorSeverity);


Enumerated values:
  public final static int esInfo = 0;
  public final static int esWarning = 1;
  public final static int esFatal = 2;

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

ExternalCrypto Property (OCSPServer Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

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.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (OCSPServer Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

GoodEntries Property (OCSPServer Class)

Contains a list of valid and active certificate entries.

Syntax

public CRLEntryInfoList getGoodEntries();


public void setGoodEntries(CRLEntryInfoList goodEntries);

Remarks

Use this property to provide a list of entried a 'good' status for which is returned. Provide the entries manually, or import them from a certificate collection using ImportGoodCertificates method.

Use BadEntries to provide a list of revoked certificates.

The entries that are neither good nor bad are reported with Unknown status.

This property is not available at design time.

Please refer to the CRLEntryInfo type for a complete list of fields.

Host Property (OCSPServer Class)

The host to bind the listening port to.

Syntax

public String getHost();


public void setHost(String host);

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

PinnedCerts Property (OCSPServer Class)

A collection of certificates to be imported.

Syntax

public CertificateList getPinnedCerts();


public void setPinnedCerts(CertificateList pinnedCerts);

Remarks

Use this property to provide a list of certificates to be imported into GoodEntries or BadEntries list using ImportGoodCertificates or ImportBadCertificates calls respectively.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

PinnedClient Property (OCSPServer Class)

Populates the pinned client details.

Syntax

public TLSClientEntry getPinnedClient();

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.

Please refer to the TLSClientEntry type for a complete list of fields.

PinnedClientChain Property (OCSPServer Class)

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

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.

Please refer to the Certificate type for a complete list of fields.

Port Property (OCSPServer Class)

Specifies the port number to listen for connections on.

Syntax

public int getPort();


public void setPort(int port);

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.

PortRangeFrom Property (OCSPServer Class)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

public int getPortRangeFrom();


public void setPortRangeFrom(int portRangeFrom);

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.

PortRangeTo Property (OCSPServer Class)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

public int getPortRangeTo();


public void setPortRangeTo(int portRangeTo);

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.

ServerCertificates Property (OCSPServer Class)

The server's TLS certificates.

Syntax

public CertificateList getServerCertificates();


public void setServerCertificates(CertificateList serverCertificates);

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.

Please refer to the Certificate type for a complete list of fields.

SigningCertificate Property (OCSPServer Class)

The certificate to use for signing.

Syntax

public Certificate getSigningCertificate();


public void setSigningCertificate(Certificate signingCertificate);

Remarks

Use this property to provide the certificate which is to be used for signing outgoing OCSP responses. This certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SocketSettings Property (OCSPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

TLSSettings Property (OCSPServer Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

UpdatePeriod Property (OCSPServer Class)

The server's information update period.

Syntax

public int getUpdatePeriod();


public void setUpdatePeriod(int updatePeriod);

Default Value

86400

Remarks

Provide the server information update period here. This value is used as a basis for the NextUpdate parameter of the responses.

Users Property (OCSPServer Class)

Provides a list of registered users.

Syntax

public UserAccountList getUsers();


public void setUsers(UserAccountList users);

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.

Please refer to the UserAccount type for a complete list of fields.

WebsiteName Property (OCSPServer Class)

Specifies the web site name to use in the certificate.

Syntax

public String getWebsiteName();


public void setWebsiteName(String websiteName);

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'.

Config Method (Ocspserver Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DoAction Method (Ocspserver Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

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;....

DropClient Method (Ocspserver Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetRequestBytes Method (Ocspserver Class)

Returns the contents of the client's HTTP request.

Syntax

public byte[] getRequestBytes(long connectionId);

Remarks

Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty.

GetRequestHeader Method (Ocspserver Class)

Returns a request header value.

Syntax

public String getRequestHeader(long connectionId, String headerName);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

GetRequestString Method (Ocspserver Class)

Returns the contents of the client's HTTP request.

Syntax

public String getRequestString(long connectionId);

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

GetRequestUsername Method (Ocspserver Class)

Returns the username for a connection.

Syntax

public String getRequestUsername(long connectionId);

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

ImportBadCertificates Method (Ocspserver Class)

Imports revoked certificates.

Syntax

public void importBadCertificates();

Remarks

This method imports a collection of bad (revoked) certificates into BadEntries list. Provide the certificates via PinnedCerts property.

ImportGoodCertificates Method (Ocspserver Class)

Imports good certificates.

Syntax

public void importGoodCertificates();

Remarks

This method imports a collection of good (active) certificates into GoodEntries list. Provide the certificates via PinnedCerts property.

ListClients Method (Ocspserver Class)

Enumerates the connected clients.

Syntax

public String 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.

PinClient Method (Ocspserver Class)

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessGenericRequest Method (Ocspserver Class)

Processes a generic OCSP status request.

Syntax

public byte[] processGenericRequest(byte[] requestBytes, boolean basicOnly);

Remarks

This method processes a generic status request and produces a response. Use it to generate OCSP statuses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes StatusRequest to consult about the request and response details with the application.

If BasicOnly is set, the return value will only contain the BasicOCSPResponse piece of the response. If it is switched off, the whole OCSPResponse structure will be returned.

Start Method (Ocspserver Class)

Starts the server.

Syntax

public void start();

Remarks

Use this method to activate the server and start listening to incoming connections.

Stop Method (Ocspserver Class)

Stops the server.

Syntax

public void stop();

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (Ocspserver Class)

Reports an incoming connection.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void accept(OcspserverAcceptEvent e) {}
  ...
}

public class OcspserverAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept;
}

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 (Ocspserver Class)

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void authAttempt(OcspserverAuthAttemptEvent e) {}
  ...
}

public class OcspserverAuthAttemptEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public String authMethod;
  public String username;
  public String password;
  public boolean allow;
}

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 (Ocspserver Class)

Reports an accepted connection.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void connect(OcspserverConnectEvent e) {}
  ...
}

public class OcspserverConnectEvent {
  public long connectionID;
  public String remoteAddress;
  public int remotePort;
}

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 GetRequest or AuthAttempt.

Disconnect Event (Ocspserver Class)

Fires to report a disconnected client.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void disconnect(OcspserverDisconnectEvent e) {}
  ...
}

public class OcspserverDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Error Event (Ocspserver Class)

Information about errors during data delivery.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void error(OcspserverErrorEvent e) {}
  ...
}

public class OcspserverErrorEvent {
  public long connectionId;
  public int errorCode;
  public String description;
}

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 (Ocspserver Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void externalSign(OcspserverExternalSignEvent e) {}
  ...
}

public class OcspserverExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData;
}

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(); };

Notification Event (Ocspserver Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void notification(OcspserverNotificationEvent e) {}
  ...
}

public class OcspserverNotificationEvent {
  public String eventID;
  public String eventParam;
}

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.

StatusRequest Event (Ocspserver Class)

Requests a certificate status from the application.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void statusRequest(OcspserverStatusRequestEvent e) {}
  ...
}

public class OcspserverStatusRequestEvent {
  public long connectionId;
  public String hashAlgorithm;
  public byte[] issuerNameHash;
  public byte[] issuerKeyHash;
  public byte[] certificateSerial;
  public int certStatus;
  public int reason;
  public String revocationTime;
  public String thisUpdate;
  public String nextUpdate;
}

Remarks

Subscribe to this event to provide, alter, or inspect certificate statuses produced by the OCSP server.

ConnectionId returns the unique identifier of the client making the request. IssuerNameHash and IssuerKeyHash specify the message digests of the certificate issuer's name and public key obtained with the use of HashAlgorithm. CertificateSerial specifies the serial number of the checked certificate.

Use the by-ref parameters CertStatus, Reason, RevocationTime, ThisUpdate, and NextUpdate to check or alter the status details of the requested certificate.

TLSCertValidate Event (Ocspserver Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void TLSCertValidate(OcspserverTLSCertValidateEvent e) {}
  ...
}

public class OcspserverTLSCertValidateEvent {
  public long connectionID;
  public boolean accept;
}

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 (Ocspserver Class)

Reports the setup of a TLS session.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void TLSEstablished(OcspserverTLSEstablishedEvent e) {}
  ...
}

public class OcspserverTLSEstablishedEvent {
  public long connectionID;
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSPSK Event (Ocspserver Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void TLSPSK(OcspserverTLSPSKEvent e) {}
  ...
}

public class OcspserverTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK;
  public String ciphersuite;
}

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 (Ocspserver Class)

Reports closure of a TLS session.

Syntax

public class DefaultOcspserverEventListener implements OcspserverEventListener {
  ...
  public void TLSShutdown(OcspserverTLSShutdownEvent e) {}
  ...
}

public class OcspserverTLSShutdownEvent {
  public long connectionID;
}

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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

CRLEntryInfo Type

Represents a single entry of a Certificate Revocation List (CRL).

Remarks

This object contains revocation information for a particular certificate entry in the CRL.

Fields

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

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

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

Creates a new SocketSettings object.

TLSClientEntry Type

A container for a connected TLS client's details.

Remarks

Use this property to access the details of a particular connected client.

Fields

Constructors

public TLSClientEntry();

Creates a new TLSClientEntry object.

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

Creates a new TLSSettings object.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

public UserAccount();

Creates a new UserAccount object.

Config Settings (Ocspserver 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.

OCSPServer Config Settings

Base Config Settings

Trappable Errors (Ocspserver Class)

OCSPServer Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)