DCAuthWebServer Class

Properties   Methods   Events   Config Settings   Errors  

The DCAuthWebServer Class 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 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 (DCAuthWebServer 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.

AllowOrigin Property (DCAuthWebServer Class)

Specifies the content of AllowOrigin header of the service reply.

Syntax

public String getAllowOrigin();
public void setAllowOrigin(String allowOrigin);

Default Value

""

Remarks

Use this property to specify the content of AllowOrigin header included with the service reply. If left empty, the * header will be returned.

AuthRealm Property (DCAuthWebServer 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.

AuthTypes Property (DCAuthWebServer Class)

Defines allowed HTTP authentication types.

Syntax

public int getAuthTypes();
public void setAuthTypes(int authTypes);

Default Value

0

Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

BoundPort Property (DCAuthWebServer 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.

ExternalCrypto Property (DCAuthWebServer 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 (DCAuthWebServer Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (DCAuthWebServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

public int getHandshakeTimeout();
public void setHandshakeTimeout(int handshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (DCAuthWebServer 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.

KeyId Property (DCAuthWebServer Class)

Specifies the KeyID of the pre-shared authentication key.

Syntax

public String getKeyId();
public void setKeyId(String keyId);

Default Value

""

Remarks

If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the KeySecret property. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.

KeySecret Property (DCAuthWebServer Class)

The pre-shared authentication key.

Syntax

public String getKeySecret();
public void setKeySecret(String keySecret);

Default Value

""

Remarks

If processing requests from a single known party, assign the key you pre-shared with them to this property. Use KeyId property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.

PinnedClient Property (DCAuthWebServer Class)

Populates the pinned client details.

Syntax

public TLSConnectionInfo 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 TLSConnectionInfo type for a complete list of fields.

PinnedClientChain Property (DCAuthWebServer 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.

Policies Property (DCAuthWebServer Class)

Specifies the policies to use when processing requests.

Syntax

public int getPolicies();
public void setPolicies(int policies);

Default Value

0

Remarks

This property lets you specify policies to apply blanketly to the requests. If this property does not give you enough flexibility - for example, if you need to cherry-pick requests basing on their content - please consider using the SignRequest (allows you to track individual requests) and/or ExternalSign (lets you perform the signing manually) events. This setting is a bit mask of the following flags:

This property is not available at design time.

Port Property (DCAuthWebServer 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 (DCAuthWebServer 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 (DCAuthWebServer 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.

SessionTimeout Property (DCAuthWebServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

public int getSessionTimeout();
public void setSessionTimeout(int sessionTimeout);

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

SignEndpoint Property (DCAuthWebServer Class)

The signing service endpoint.

Syntax

public String getSignEndpoint();
public void setSignEndpoint(String signEndpoint);

Default Value

"/sign"

Remarks

Use this property to specify the signing service end point on the server.

SigningCertificate Property (DCAuthWebServer Class)

The certificate to be used for signing.

Syntax

public Certificate getSigningCertificate();
public void setSigningCertificate(Certificate signingCertificate);

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

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

SigningChain Property (DCAuthWebServer Class)

The signing certificate chain.

Syntax

public CertificateList getSigningChain();
public void setSigningChain(CertificateList signingChain);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

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

SocketSettings Property (DCAuthWebServer 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.

StorageId Property (DCAuthWebServer Class)

Specifies the signing certificate residing in an alternative location.

Syntax

public String getStorageId();
public void setStorageId(String storageId);

Default Value

""

Remarks

Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.

Example 1: The certificate resides on a PKCS#11 device

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1

Example 2: The certificate resides in a system store

system://localmachine@/?store=MY

You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:

• cn: the common name of the certificate subject.
• keyid: the unique identifier included in subject key identifier extension of the certificate.
• keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
• fingerprint: the fingerprint of the certificate.

Example 3: selecting the certificate with a given fingerprint:

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344

TimestampServer Property (DCAuthWebServer Class)

The address of the timestamping server.

Syntax

public String getTimestampServer();
public void setTimestampServer(String timestampServer);

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

TLSServerChain Property (DCAuthWebServer Class)

The server's TLS certificates.

Syntax

public CertificateList getTLSServerChain();
public void setTLSServerChain(CertificateList TLSServerChain);

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.

TLSSettings Property (DCAuthWebServer 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.

Users Property (DCAuthWebServer 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 (DCAuthWebServer 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'.

Cleanup Method (DCAuthWebServer Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

public void cleanup();

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (DCAuthWebServer 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 (DCAuthWebServer 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;....

Common ActionIDs:

DropClient Method (DCAuthWebServer 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.

ListClients Method (DCAuthWebServer 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 (DCAuthWebServer 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.

Reset Method (DCAuthWebServer Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

Start Method (DCAuthWebServer Class)

Starts the server.

Syntax

public void start();

Remarks

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

Stop Method (DCAuthWebServer Class)

Stops the server.

Syntax

public void stop();

Remarks

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

Accept Event (DCAuthWebServer Class)

Reports an incoming connection.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void accept(DCAuthWebServerAcceptEvent e) {}
  ...
}

public class DCAuthWebServerAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept; //read-write
}

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

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void authAttempt(DCAuthWebServerAuthAttemptEvent e) {}
  ...
}

public class DCAuthWebServerAuthAttemptEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public String authMethod;
  public String username;
  public String password;
  public boolean allow; //read-write
}

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

Reports an accepted connection.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void connect(DCAuthWebServerConnectEvent e) {}
  ...
}

public class DCAuthWebServerConnectEvent {
  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 TLSHandshake or Data.

CustomParametersReceived Event (DCAuthWebServer Class)

Passes custom request parameters to the application.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void customParametersReceived(DCAuthWebServerCustomParametersReceivedEvent e) {}
  ...
}

public class DCAuthWebServerCustomParametersReceivedEvent {
  public long connectionId;
  public String value;
}

Remarks

Subscribe to this event to access custom signing parameters supplied by the signer in their request. The Value string contains the parameters as included by the requestor.

Disconnect Event (DCAuthWebServer Class)

Fires to report a disconnected client.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void disconnect(DCAuthWebServerDisconnectEvent e) {}
  ...
}

public class DCAuthWebServerDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Error Event (DCAuthWebServer Class)

Information about errors during data delivery.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void error(DCAuthWebServerErrorEvent e) {}
  ...
}

public class DCAuthWebServerErrorEvent {
  public long connectionID;
  public int errorCode;
  public boolean fatal;
  public boolean remote;
  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 (DCAuthWebServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void externalSign(DCAuthWebServerExternalSignEvent e) {}
  ...
}

public class DCAuthWebServerExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

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

KeySecretNeeded Event (DCAuthWebServer Class)

Requests the key secret from the application.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void keySecretNeeded(DCAuthWebServerKeySecretNeededEvent e) {}
  ...
}

public class DCAuthWebServerKeySecretNeededEvent {
  public long connectionId;
  public String keyId;
  public String keySecret; //read-write
}

Remarks

Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the KeyId, a non-secret unique key identifier, and the KeySecret, shared by the parties, which should be kept private. This event is an alternative for KeySecret property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via KeyId and KeySecret properties would be an easier route.

Log Event (DCAuthWebServer Class)

Reports a single log line.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void log(DCAuthWebServerLogEvent e) {}
  ...
}

public class DCAuthWebServerLogEvent {
  public long connectionId;
  public int logType;
  public String details;
}

Remarks

This event is fired repeatedly during the component's work to inform the application about the flow of the signing process. The application may use this event to create an operation log.

Notification Event (DCAuthWebServer Class)

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

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void notification(DCAuthWebServerNotificationEvent e) {}
  ...
}

public class DCAuthWebServerNotificationEvent {
  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.

ParameterReceived Event (DCAuthWebServer Class)

Passes a standard request parameter to the user code.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void parameterReceived(DCAuthWebServerParameterReceivedEvent e) {}
  ...
}

public class DCAuthWebServerParameterReceivedEvent {
  public long connectionId;
  public String name;
  public String value;
}

Remarks

This event is fired when one of 'standard' protocol parameters has been found in the request:

• SessionID
• DataURL
• GoURL
• Token
• PKCS11Libraries
• AllowFileStorage
• AllowTokenStorage
• AllowWindowsStorage
• AllowOSStorage

Parameters are reported one-by-one upon being processed.

PasswordNeeded Event (DCAuthWebServer Class)

Requests a password from the application.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void passwordNeeded(DCAuthWebServerPasswordNeededEvent e) {}
  ...
}

public class DCAuthWebServerPasswordNeededEvent {
  public String neededFor;
  public String id;
  public String password; //read-write
  public boolean cancel; //read-write
}

Remarks

Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.

ReadOption Event (DCAuthWebServer Class)

Fires when the client sends in a read option request.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void readOption(DCAuthWebServerReadOptionEvent e) {}
  ...
}

public class DCAuthWebServerReadOptionEvent {
  public long connectionId;
  public String name;
  public String value; //read-write
  public boolean success; //read-write
}

Remarks

Subscribe to this event to respond to the clients' read option requests. The handler should retrieve the value of the requested option from a local configuration setting and assign it to the Value parameter.

SelectCert Event (DCAuthWebServer Class)

Requests certificate selection criteria from the application.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void selectCert(DCAuthWebServerSelectCertEvent e) {}
  ...
}

public class DCAuthWebServerSelectCertEvent {
  public long connectionId;
  public String commonName; //read-write
  public String keyID; //read-write
  public String keyUsage; //read-write
  public String fingerprint; //read-write
  public String storeType; //read-write
}

Remarks

Subscribe to this event to provide signing certificate details on the fly, right before the hash is signed.

SignRequest Event (DCAuthWebServer Class)

This event signifies the processing of an atomic signing request.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void signRequest(DCAuthWebServerSignRequestEvent e) {}
  ...
}

public class DCAuthWebServerSignRequestEvent {
  public long connectionId;
  public int method;
  public String hashAlgorithm;
  public byte[] hash;
  public String keyID;
  public String pars;
  public String methodPars;
  public boolean allow; //read-write
}

Remarks

Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The Method parameter specifies the async signing method requested by the client:

The Hash parameter contains the hash, made using HashAlgorithm, that needs to be signed. KeyID contains the key identifier of the requestor.

The Pars string contains a semicolon-separated string of the principal signature parameters. This has the same format and content that is passed to ExternalSign, if it is used. The MethodPars contains a similar parameter string, but for the specific async signing method used. For the PKCS1 method there are no defined method parameters, while the PKCS7 method supports a selection of settings that tune up the CMS blob.

Set Allow to false to reject the request. Use the SignRequestCompleted event to track completion of the initiated operation.

SignRequestCompleted Event (DCAuthWebServer Class)

This event signifies completion of the processing of an atomic signing request.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void signRequestCompleted(DCAuthWebServerSignRequestCompletedEvent e) {}
  ...
}

public class DCAuthWebServerSignRequestCompletedEvent {
  public long connectionId;
  public int method;
  public String hashAlgorithm;
  public byte[] hash;
  public String keyID;
  public String pars;
  public String methodPars;
  public byte[] signature;
}

Remarks

Use this event to track completion of signing request processing. The Hash parameter contains the hash that is signed, as supplied by the requestor, and the Signature parameter contains the resulting cryptographic signature. The Username parameter matches the parameter in SignRequest event.

TimestampRequest Event (DCAuthWebServer Class)

Fires when the class is ready to request a timestamp from an external TSA.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void timestampRequest(DCAuthWebServerTimestampRequestEvent e) {}
  ...
}

public class DCAuthWebServerTimestampRequestEvent {
  public String TSA;
  public String timestampRequest;
  public String timestampResponse; //read-write
  public boolean suppressDefault; //read-write
}

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

TLSCertValidate Event (DCAuthWebServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void TLSCertValidate(DCAuthWebServerTLSCertValidateEvent e) {}
  ...
}

public class DCAuthWebServerTLSCertValidateEvent {
  public long connectionID;
  public boolean accept; //read-write
}

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

Reports the setup of a TLS session.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void TLSEstablished(DCAuthWebServerTLSEstablishedEvent e) {}
  ...
}

public class DCAuthWebServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

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

TLSHandshake Event (DCAuthWebServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void TLSHandshake(DCAuthWebServerTLSHandshakeEvent e) {}
  ...
}

public class DCAuthWebServerTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort; //read-write
}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (DCAuthWebServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void TLSPSK(DCAuthWebServerTLSPSKEvent e) {}
  ...
}

public class DCAuthWebServerTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK; //read-write
  public String ciphersuite; //read-write
}

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

Reports closure of a TLS session.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void TLSShutdown(DCAuthWebServerTLSShutdownEvent e) {}
  ...
}

public class DCAuthWebServerTLSShutdownEvent {
  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.

WriteOption Event (DCAuthWebServer Class)

Fires when the client sends in a write option request.

Syntax

public class DefaultDCAuthWebServerEventListener implements DCAuthWebServerEventListener {
  ...
  public void writeOption(DCAuthWebServerWriteOptionEvent e) {}
  ...
}

public class DCAuthWebServerWriteOptionEvent {
  public long connectionId;
  public String name;
  public String value;
}

Remarks

Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

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

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

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

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

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public TLSConnectionInfo();

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

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

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

DCAuthWebServer Config Settings

Base Config Settings

Trappable Errors (DCAuthWebServer Class)