DCAuthWebServer Component

Properties   Methods   Events   Config Settings   Errors  

The DCAuthWebServer Component offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.

Syntax

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

Method List

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

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.

Config Settings

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

Active Property (DCAuthWebServer Component)

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

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

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 Component)

Specifies the content of AllowOrigin header of the service reply.

Syntax

• C#
• VB.NET

public string AllowOrigin { get; set; }

Public Property AllowOrigin As String

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 Component)

Specifies authentication realm for digest and NTLM authentication

Syntax

• C#
• VB.NET

public string AuthRealm { get; set; }

Public Property AuthRealm As String

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (DCAuthWebServer Component)

Defines allowed HTTP authentication types.

Syntax

• C#
• VB.NET

public int AuthTypes { get; set; }

Public Property AuthTypes As Integer

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 Component)

Indicates the bound listening port.

Syntax

• C#
• VB.NET

public int BoundPort { get; }

Public ReadOnly Property BoundPort As Integer

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 Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

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.

FIPSMode Property (DCAuthWebServer Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (DCAuthWebServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

• C#
• VB.NET

public int HandshakeTimeout { get; set; }

Public Property HandshakeTimeout As Integer

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (DCAuthWebServer Component)

The host to bind the listening port to.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

Default Value

""

Remarks

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

KeyId Property (DCAuthWebServer Component)

Specifies the KeyID of the pre-shared authentication key.

Syntax

• C#
• VB.NET

public string KeyId { get; set; }

Public Property KeyId As String

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 Component)

The pre-shared authentication key.

Syntax

• C#
• VB.NET

public string KeySecret { get; set; }

Public Property KeySecret As String

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 Component)

Populates the pinned client details.

Syntax

• C#
• VB.NET

public TLSConnectionInfo PinnedClient { get; }

Public ReadOnly Property PinnedClient As TLSConnectionInfo

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.

PinnedClientChain Property (DCAuthWebServer Component)

Contains the certificate chain of the pinned client.

Syntax

• C#
• VB.NET

public CertificateList PinnedClientChain { get; }

Public ReadOnly Property PinnedClientChain As CertificateList

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.

Policies Property (DCAuthWebServer Component)

Specifies the policies to use when processing requests.

Syntax

• C#
• VB.NET

public int Policies { get; set; }

Public Property Policies As Integer

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 Component)

Specifies the port number to listen for connections on.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

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 Component)

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

Syntax

• C#
• VB.NET

public int PortRangeFrom { get; set; }

Public Property PortRangeFrom As Integer

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 Component)

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

Syntax

• C#
• VB.NET

public int PortRangeTo { get; set; }

Public Property PortRangeTo As Integer

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 Component)

Specifies the default session timeout value in milliseconds.

Syntax

• C#
• VB.NET

public int SessionTimeout { get; set; }

Public Property SessionTimeout As Integer

Default Value

360000

Remarks

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

SignEndpoint Property (DCAuthWebServer Component)

The signing service endpoint

Syntax

• C#
• VB.NET

public string SignEndpoint { get; set; }

Public Property SignEndpoint As String

Default Value

"/sign"

Remarks

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

SigningCertificate Property (DCAuthWebServer Component)

The certificate to be used for signing.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; set; }

Public Property SigningCertificate As Certificate

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.

SigningChain Property (DCAuthWebServer Component)

The signing certificate chain.

Syntax

• C#
• VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

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.

SocketSettings Property (DCAuthWebServer Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

StorageId Property (DCAuthWebServer Component)

Specifies the signing certificate residing in an alternative location

Syntax

• C#
• VB.NET

public string StorageId { get; set; }

Public Property StorageId As String

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 Component)

The address of the timestamping server.

Syntax

• C#
• VB.NET

public string TimestampServer { get; set; }

Public Property TimestampServer As String

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 Component)

The server's TLS certificates.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public Property TLSServerChain As CertificateList

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.

TLSSettings Property (DCAuthWebServer Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Users Property (DCAuthWebServer Component)

Provides a list of registered users.

Syntax

• C#
• VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the component.

This property is not available at design time.

WebsiteName Property (DCAuthWebServer Component)

Specifies the web site name to use in the certificate.

Syntax

• C#
• VB.NET

public string WebsiteName { get; set; }

Public Property WebsiteName As String

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 Component)

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

Syntax

• C#
• VB.NET

public void Cleanup();

Public Sub 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 Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 Component)

Terminates a client connection.

Syntax

• C#
• VB.NET

public void DropClient(long connectionId, bool forced);

Public Sub DropClient(ByVal ConnectionId As Long, ByVal Forced As Boolean)

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 Component)

Enumerates the connected clients.

Syntax

• C#
• VB.NET

public string ListClients();

Public Function ListClients() As String

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 Component)

Takes a snapshot of the connection's properties.

Syntax

• C#
• VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

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 Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

Start Method (DCAuthWebServer Component)

Starts the server.

Syntax

• C#
• VB.NET

public void Start();

Public Sub Start()

Remarks

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

Stop Method (DCAuthWebServer Component)

Stops the server.

Syntax

• C#
• VB.NET

public void Stop();

Public Sub Stop()

Remarks

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

Accept Event (DCAuthWebServer Component)

Reports an incoming connection.

Syntax

• C#
• VB.NET

public event OnAcceptHandler OnAccept;

public delegate void OnAcceptHandler(object sender, DCAuthWebServerAcceptEventArgs e);

public class DCAuthWebServerAcceptEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool Accept { get; set; }
}

Public Event OnAccept As OnAcceptHandler

Public Delegate Sub OnAcceptHandler(sender As Object, e As DCAuthWebServerAcceptEventArgs)

Public Class DCAuthWebServerAcceptEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property Accept As Boolean
End Class

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 Component)

Fires when a connected client makes an authentication attempt.

Syntax

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, DCAuthWebServerAuthAttemptEventArgs e);

public class DCAuthWebServerAuthAttemptEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URI { get; }
  public string AuthMethod { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Allow { get; set; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As DCAuthWebServerAuthAttemptEventArgs)

Public Class DCAuthWebServerAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URI As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Allow As Boolean
End Class

Remarks

The component 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 Component)

Reports an accepted connection.

Syntax

• C#
• VB.NET

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, DCAuthWebServerConnectEventArgs e);

public class DCAuthWebServerConnectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
}

Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As DCAuthWebServerConnectEventArgs)

Public Class DCAuthWebServerConnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
End Class

Remarks

The component 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 Component)

Passes custom request parameters to the application.

Syntax

• C#
• VB.NET

public event OnCustomParametersReceivedHandler OnCustomParametersReceived;

public delegate void OnCustomParametersReceivedHandler(object sender, DCAuthWebServerCustomParametersReceivedEventArgs e);

public class DCAuthWebServerCustomParametersReceivedEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Value { get; }
}

Public Event OnCustomParametersReceived As OnCustomParametersReceivedHandler

Public Delegate Sub OnCustomParametersReceivedHandler(sender As Object, e As DCAuthWebServerCustomParametersReceivedEventArgs)

Public Class DCAuthWebServerCustomParametersReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Value As String
End Class

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 Component)

Fires to report a disconnected client.

Syntax

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, DCAuthWebServerDisconnectEventArgs e);

public class DCAuthWebServerDisconnectEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As DCAuthWebServerDisconnectEventArgs)

Public Class DCAuthWebServerDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when a connected client disconnects.

Error Event (DCAuthWebServer Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, DCAuthWebServerErrorEventArgs e);

public class DCAuthWebServerErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int ErrorCode { get; }
  public bool Fatal { get; }
  public bool Remote { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As DCAuthWebServerErrorEventArgs)

Public Class DCAuthWebServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Fatal As Boolean
  Public ReadOnly Property Remote As Boolean
  Public ReadOnly Property Description As String
End Class

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 Component)

Handles remote or external signing initiated by the server protocol.

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, DCAuthWebServerExternalSignEventArgs e);

public class DCAuthWebServerExternalSignEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As DCAuthWebServerExternalSignEventArgs)

Public Class DCAuthWebServerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

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 component via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The component 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 Component)

Requests the key secret from the application.

Syntax

• C#
• VB.NET

public event OnKeySecretNeededHandler OnKeySecretNeeded;

public delegate void OnKeySecretNeededHandler(object sender, DCAuthWebServerKeySecretNeededEventArgs e);

public class DCAuthWebServerKeySecretNeededEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string KeyId { get; }
  public string KeySecret { get; set; }
}

Public Event OnKeySecretNeeded As OnKeySecretNeededHandler

Public Delegate Sub OnKeySecretNeededHandler(sender As Object, e As DCAuthWebServerKeySecretNeededEventArgs)

Public Class DCAuthWebServerKeySecretNeededEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property KeyId As String
  Public Property KeySecret As String
End Class

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 Component)

Reports a single log line.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, DCAuthWebServerLogEventArgs e);

public class DCAuthWebServerLogEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int LogType { get; }
  public string Details { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As DCAuthWebServerLogEventArgs)

Public Class DCAuthWebServerLogEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property LogType As Integer
  Public ReadOnly Property Details As String
End Class

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 Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, DCAuthWebServerNotificationEventArgs e);

public class DCAuthWebServerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As DCAuthWebServerNotificationEventArgs)

Public Class DCAuthWebServerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

ParameterReceived Event (DCAuthWebServer Component)

Passes a standard request parameter to the user code.

Syntax

• C#
• VB.NET

public event OnParameterReceivedHandler OnParameterReceived;

public delegate void OnParameterReceivedHandler(object sender, DCAuthWebServerParameterReceivedEventArgs e);

public class DCAuthWebServerParameterReceivedEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Name { get; }
  public string Value { get; }
}

Public Event OnParameterReceived As OnParameterReceivedHandler

Public Delegate Sub OnParameterReceivedHandler(sender As Object, e As DCAuthWebServerParameterReceivedEventArgs)

Public Class DCAuthWebServerParameterReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
End Class

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

PasswordNeeded Event (DCAuthWebServer Component)

Requests a password from the application.

Syntax

• C#
• VB.NET

public event OnPasswordNeededHandler OnPasswordNeeded;

public delegate void OnPasswordNeededHandler(object sender, DCAuthWebServerPasswordNeededEventArgs e);

public class DCAuthWebServerPasswordNeededEventArgs : EventArgs {
  public string NeededFor { get; }
  public string Id { get; }
  public string Password { get; set; }
  public bool Cancel { get; set; }
}

Public Event OnPasswordNeeded As OnPasswordNeededHandler

Public Delegate Sub OnPasswordNeededHandler(sender As Object, e As DCAuthWebServerPasswordNeededEventArgs)

Public Class DCAuthWebServerPasswordNeededEventArgs Inherits EventArgs
  Public ReadOnly Property NeededFor As String
  Public ReadOnly Property Id As String
  Public Property Password As String
  Public Property Cancel As Boolean
End Class

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 Component)

Fires when the client sends in a read option request.

Syntax

• C#
• VB.NET

public event OnReadOptionHandler OnReadOption;

public delegate void OnReadOptionHandler(object sender, DCAuthWebServerReadOptionEventArgs e);

public class DCAuthWebServerReadOptionEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Name { get; }
  public string Value { get; set; }
  public bool Success { get; set; }
}

Public Event OnReadOption As OnReadOptionHandler

Public Delegate Sub OnReadOptionHandler(sender As Object, e As DCAuthWebServerReadOptionEventArgs)

Public Class DCAuthWebServerReadOptionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Name As String
  Public Property Value As String
  Public Property Success As Boolean
End Class

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 Component)

Requests certificate selection criteria from the application.

Syntax

• C#
• VB.NET

public event OnSelectCertHandler OnSelectCert;

public delegate void OnSelectCertHandler(object sender, DCAuthWebServerSelectCertEventArgs e);

public class DCAuthWebServerSelectCertEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string CommonName { get; set; }
  public string KeyID { get; set; }
  public string KeyUsage { get; set; }
  public string Fingerprint { get; set; }
  public string StoreType { get; set; }
}

Public Event OnSelectCert As OnSelectCertHandler

Public Delegate Sub OnSelectCertHandler(sender As Object, e As DCAuthWebServerSelectCertEventArgs)

Public Class DCAuthWebServerSelectCertEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public Property CommonName As String
  Public Property KeyID As String
  Public Property KeyUsage As String
  Public Property Fingerprint As String
  Public Property StoreType As String
End Class

Remarks

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

SignRequest Event (DCAuthWebServer Component)

This event signifies the processing of an atomic signing request.

Syntax

• C#
• VB.NET

public event OnSignRequestHandler OnSignRequest;

public delegate void OnSignRequestHandler(object sender, DCAuthWebServerSignRequestEventArgs e);

public class DCAuthWebServerSignRequestEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int Method { get; }
  public string HashAlgorithm { get; }
  public byte[] Hash { get; }
  public string KeyID { get; }
  public string Pars { get; }
  public string MethodPars { get; }
  public bool Allow { get; set; }
}

Public Event OnSignRequest As OnSignRequestHandler

Public Delegate Sub OnSignRequestHandler(sender As Object, e As DCAuthWebServerSignRequestEventArgs)

Public Class DCAuthWebServerSignRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Method As Integer
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Hash As Byte()
  Public ReadOnly Property KeyID As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property MethodPars As String
  Public Property Allow As Boolean
End Class

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 Component)

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

Syntax

• C#
• VB.NET

public event OnSignRequestCompletedHandler OnSignRequestCompleted;

public delegate void OnSignRequestCompletedHandler(object sender, DCAuthWebServerSignRequestCompletedEventArgs e);

public class DCAuthWebServerSignRequestCompletedEventArgs : EventArgs {
  public long ConnectionId { get; }
  public int Method { get; }
  public string HashAlgorithm { get; }
  public byte[] Hash { get; }
  public string KeyID { get; }
  public string Pars { get; }
  public string MethodPars { get; }
  public byte[] Signature { get; }
}

Public Event OnSignRequestCompleted As OnSignRequestCompletedHandler

Public Delegate Sub OnSignRequestCompletedHandler(sender As Object, e As DCAuthWebServerSignRequestCompletedEventArgs)

Public Class DCAuthWebServerSignRequestCompletedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Method As Integer
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Hash As Byte()
  Public ReadOnly Property KeyID As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property MethodPars As String
  Public ReadOnly Property Signature As Byte()
End Class

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 Component)

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

Syntax

• C#
• VB.NET

public event OnTimestampRequestHandler OnTimestampRequest;

public delegate void OnTimestampRequestHandler(object sender, DCAuthWebServerTimestampRequestEventArgs e);

public class DCAuthWebServerTimestampRequestEventArgs : EventArgs {
  public string TSA { get; }
  public string TimestampRequest { get; }
  public string TimestampResponse { get; set; }
  public bool SuppressDefault { get; set; }
}

Public Event OnTimestampRequest As OnTimestampRequestHandler

Public Delegate Sub OnTimestampRequestHandler(sender As Object, e As DCAuthWebServerTimestampRequestEventArgs)

Public Class DCAuthWebServerTimestampRequestEventArgs Inherits EventArgs
  Public ReadOnly Property TSA As String
  Public ReadOnly Property TimestampRequest As String
  Public Property TimestampResponse As String
  Public Property SuppressDefault As Boolean
End Class

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 Component)

Fires when a client certificate needs to be validated.

Syntax

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, DCAuthWebServerTLSCertValidateEventArgs e);

public class DCAuthWebServerTLSCertValidateEventArgs : EventArgs {
  public long ConnectionID { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As DCAuthWebServerTLSCertValidateEventArgs)

Public Class DCAuthWebServerTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Accept As Boolean
End Class

Remarks

The component 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 Component)

Reports the setup of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, DCAuthWebServerTLSEstablishedEventArgs e);

public class DCAuthWebServerTLSEstablishedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As DCAuthWebServerTLSEstablishedEventArgs)

Public Class DCAuthWebServerTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

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

TLSHandshake Event (DCAuthWebServer Component)

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

Syntax

• C#
• VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, DCAuthWebServerTLSHandshakeEventArgs e);

public class DCAuthWebServerTLSHandshakeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ServerName { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As DCAuthWebServerTLSHandshakeEventArgs)

Public Class DCAuthWebServerTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ServerName As String
  Public Property Abort As Boolean
End Class

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 Component)

Requests a pre-shared key for TLS-PSK.

Syntax

• C#
• VB.NET

public event OnTLSPSKHandler OnTLSPSK;

public delegate void OnTLSPSKHandler(object sender, DCAuthWebServerTLSPSKEventArgs e);

public class DCAuthWebServerTLSPSKEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Identity { get; }
  public string PSK { get; set; }
  public string Ciphersuite { get; set; }
}

Public Event OnTLSPSK As OnTLSPSKHandler

Public Delegate Sub OnTLSPSKHandler(sender As Object, e As DCAuthWebServerTLSPSKEventArgs)

Public Class DCAuthWebServerTLSPSKEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Identity As String
  Public Property PSK As String
  Public Property Ciphersuite As String
End Class

Remarks

The component 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 Component)

Reports closure of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, DCAuthWebServerTLSShutdownEventArgs e);

public class DCAuthWebServerTLSShutdownEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As DCAuthWebServerTLSShutdownEventArgs)

Public Class DCAuthWebServerTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component 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 Component)

Fires when the client sends in a write option request.

Syntax

• C#
• VB.NET

public event OnWriteOptionHandler OnWriteOption;

public delegate void OnWriteOptionHandler(object sender, DCAuthWebServerWriteOptionEventArgs e);

public class DCAuthWebServerWriteOptionEventArgs : EventArgs {
  public long ConnectionId { get; }
  public string Name { get; }
  public string Value { get; }
}

Public Event OnWriteOption As OnWriteOptionHandler

Public Delegate Sub OnWriteOptionHandler(sender As Object, e As DCAuthWebServerWriteOptionEventArgs)

Public Class DCAuthWebServerWriteOptionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As Long
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
End Class

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

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate();

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

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

• C#
• VB.NET

public SocketSettings();

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

• C#
• VB.NET

public TLSConnectionInfo();

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

• C#
• VB.NET

public TLSSettings();

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