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

TsbxDCAuthWebServer

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

__property bool Active = { read=FActive };

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.

Data Type

Boolean

AllowOrigin Property (DCAuthWebServer Component)

Specifies the content of AllowOrigin header of the service reply.

Syntax

__property String AllowOrigin = { read=FAllowOrigin, write=FSetAllowOrigin };

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.

Data Type

String

AuthRealm Property (DCAuthWebServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

__property String AuthRealm = { read=FAuthRealm, write=FSetAuthRealm };

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

AuthTypes Property (DCAuthWebServer Component)

Defines allowed HTTP authentication types.

Syntax

__property int AuthTypes = { read=FAuthTypes, write=FSetAuthTypes };

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:

Data Type

Integer

BoundPort Property (DCAuthWebServer Component)

Indicates the bound listening port.

Syntax

__property int BoundPort = { read=FBoundPort };

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.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (DCAuthWebServer Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (DCAuthWebServer Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (DCAuthWebServer Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (DCAuthWebServer Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (DCAuthWebServer Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (DCAuthWebServer Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (DCAuthWebServer Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (DCAuthWebServer Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxDCAuthWebServerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxDCAuthWebServerExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (DCAuthWebServer Component)

Specifies the external cryptography mode.

Syntax

__property TsbxDCAuthWebServerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxDCAuthWebServerExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (DCAuthWebServer Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (DCAuthWebServer Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (DCAuthWebServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

__property int HandshakeTimeout = { read=FHandshakeTimeout, write=FSetHandshakeTimeout };

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (DCAuthWebServer Component)

The host to bind the listening port to.

Syntax

__property String Host = { read=FHost, write=FSetHost };

Default Value

""

Remarks

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

Data Type

String

KeyId Property (DCAuthWebServer Component)

Specifies the KeyID of the pre-shared authentication key.

Syntax

__property String KeyId = { read=FKeyId, write=FSetKeyId };

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.

Data Type

String

KeySecret Property (DCAuthWebServer Component)

The pre-shared authentication key.

Syntax

__property String KeySecret = { read=FKeySecret, write=FSetKeySecret };

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.

Data Type

String

PinnedClientAEADCipher Property (DCAuthWebServer Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool PinnedClientAEADCipher = { read=FPinnedClientAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientChainValidationDetails Property (DCAuthWebServer Component)

The details of a certificate chain validation outcome.

Syntax

__property int PinnedClientChainValidationDetails = { read=FPinnedClientChainValidationDetails };

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientChainValidationResult Property (DCAuthWebServer Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxDCAuthWebServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult };

enum TsbxDCAuthWebServerPinnedClientChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCiphersuite Property (DCAuthWebServer Component)

The cipher suite employed by this connection.

Syntax

__property String PinnedClientCiphersuite = { read=FPinnedClientCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientClientAuthenticated Property (DCAuthWebServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool PinnedClientClientAuthenticated = { read=FPinnedClientClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientClientAuthRequested Property (DCAuthWebServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool PinnedClientClientAuthRequested = { read=FPinnedClientClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientConnectionEstablished Property (DCAuthWebServer Component)

Indicates whether the connection has been established fully.

Syntax

__property bool PinnedClientConnectionEstablished = { read=FPinnedClientConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientConnectionID Property (DCAuthWebServer Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID };

Remarks

The unique identifier assigned to this connection.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (DCAuthWebServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientDigestAlgorithm = { read=FPinnedClientDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientEncryptionAlgorithm Property (DCAuthWebServer Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientEncryptionAlgorithm = { read=FPinnedClientEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientExportable Property (DCAuthWebServer Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

__property bool PinnedClientExportable = { read=FPinnedClientExportable };

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientID Property (DCAuthWebServer Component)

The client connection's unique identifier.

Syntax

__property __int64 PinnedClientID = { read=FPinnedClientID };

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (DCAuthWebServer Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientKeyExchangeAlgorithm = { read=FPinnedClientKeyExchangeAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientKeyExchangeKeyBits Property (DCAuthWebServer Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

__property int PinnedClientKeyExchangeKeyBits = { read=FPinnedClientKeyExchangeKeyBits };

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientNamedECCurve Property (DCAuthWebServer Component)

The elliptic curve used in this connection.

Syntax

__property String PinnedClientNamedECCurve = { read=FPinnedClientNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPFSCipher Property (DCAuthWebServer Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

__property bool PinnedClientPFSCipher = { read=FPinnedClientPFSCipher };

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientPreSharedIdentity Property (DCAuthWebServer Component)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String PinnedClientPreSharedIdentity = { read=FPinnedClientPreSharedIdentity };

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPreSharedIdentityHint Property (DCAuthWebServer Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

__property String PinnedClientPreSharedIdentityHint = { read=FPinnedClientPreSharedIdentityHint };

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPublicKeyBits Property (DCAuthWebServer Component)

The length of the public key.

Syntax

__property int PinnedClientPublicKeyBits = { read=FPinnedClientPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientRemoteAddress Property (DCAuthWebServer Component)

The client's IP address.

Syntax

__property String PinnedClientRemoteAddress = { read=FPinnedClientRemoteAddress };

Default Value

""

Remarks

The client's IP address.

This property is read-only and not available at design time.

Data Type

String

PinnedClientRemotePort Property (DCAuthWebServer Component)

The remote port of the client connection.

Syntax

__property int PinnedClientRemotePort = { read=FPinnedClientRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientResumedSession Property (DCAuthWebServer Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

__property bool PinnedClientResumedSession = { read=FPinnedClientResumedSession };

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientSecureConnection Property (DCAuthWebServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool PinnedClientSecureConnection = { read=FPinnedClientSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientServerAuthenticated Property (DCAuthWebServer Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

__property bool PinnedClientServerAuthenticated = { read=FPinnedClientServerAuthenticated };

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (DCAuthWebServer Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String PinnedClientSignatureAlgorithm = { read=FPinnedClientSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only and not available at design time.

Data Type

String

PinnedClientSymmetricBlockSize Property (DCAuthWebServer Component)

The block size of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricBlockSize = { read=FPinnedClientSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientSymmetricKeyBits Property (DCAuthWebServer Component)

The key length of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricKeyBits = { read=FPinnedClientSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientTotalBytesReceived Property (DCAuthWebServer Component)

The total number of bytes received over this connection.

Syntax

__property __int64 PinnedClientTotalBytesReceived = { read=FPinnedClientTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientTotalBytesSent Property (DCAuthWebServer Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 PinnedClientTotalBytesSent = { read=FPinnedClientTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientValidationLog Property (DCAuthWebServer Component)

Contains the server certificate's chain validation log.

Syntax

__property String PinnedClientValidationLog = { read=FPinnedClientValidationLog };

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only and not available at design time.

Data Type

String

PinnedClientVersion Property (DCAuthWebServer Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

__property String PinnedClientVersion = { read=FPinnedClientVersion };

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertCount Property (DCAuthWebServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

__property int PinnedClientCertCount = { read=FPinnedClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

The array indices start at 0 and end at PinnedClientCertCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertBytes Property (DCAuthWebServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertCAKeyID Property (DCAuthWebServer Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

__property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertFingerprint Property (DCAuthWebServer Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String PinnedClientCertFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertHandle Property (DCAuthWebServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 PinnedClientCertHandle[int PinnedClientCertIndex] = { read=FPinnedClientCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientCertIssuer Property (DCAuthWebServer Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String PinnedClientCertIssuer[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertIssuerRDN Property (DCAuthWebServer Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String PinnedClientCertIssuerRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyAlgorithm Property (DCAuthWebServer Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String PinnedClientCertKeyAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyBits Property (DCAuthWebServer Component)

Returns the length of the public key in bits.

Syntax

__property int PinnedClientCertKeyBits[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertKeyFingerprint Property (DCAuthWebServer Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

__property String PinnedClientCertKeyFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyFingerprint };

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyUsage Property (DCAuthWebServer Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int PinnedClientCertKeyUsage[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertPublicKeyBytes Property (DCAuthWebServer Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSelfSigned Property (DCAuthWebServer Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool PinnedClientCertSelfSigned[int PinnedClientCertIndex] = { read=FPinnedClientCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientCertSerialNumber Property (DCAuthWebServer Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (DCAuthWebServer Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String PinnedClientCertSigAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertSubject Property (DCAuthWebServer Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String PinnedClientCertSubject[int PinnedClientCertIndex] = { read=FPinnedClientCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertSubjectKeyID Property (DCAuthWebServer Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (DCAuthWebServer Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String PinnedClientCertSubjectRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertValidFrom Property (DCAuthWebServer Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String PinnedClientCertValidFrom[int PinnedClientCertIndex] = { read=FPinnedClientCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertValidTo Property (DCAuthWebServer Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String PinnedClientCertValidTo[int PinnedClientCertIndex] = { read=FPinnedClientCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

Policies Property (DCAuthWebServer Component)

Specifies the policies to use when processing requests.

Syntax

__property int Policies = { read=FPolicies, write=FSetPolicies };

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.

Data Type

Integer

Port Property (DCAuthWebServer Component)

Specifies the port number to listen for connections on.

Syntax

__property int Port = { read=FPort, write=FSetPort };

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.

Data Type

Integer

PortRangeFrom Property (DCAuthWebServer Component)

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

Syntax

__property int PortRangeFrom = { read=FPortRangeFrom, write=FSetPortRangeFrom };

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.

Data Type

Integer

PortRangeTo Property (DCAuthWebServer Component)

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

Syntax

__property int PortRangeTo = { read=FPortRangeTo, write=FSetPortRangeTo };

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.

Data Type

Integer

SessionTimeout Property (DCAuthWebServer Component)

Specifies the default session timeout value in milliseconds.

Syntax

__property int SessionTimeout = { read=FSessionTimeout, write=FSetSessionTimeout };

Default Value

360000

Remarks

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

Data Type

Integer

SignEndpoint Property (DCAuthWebServer Component)

The signing service endpoint.

Syntax

__property String SignEndpoint = { read=FSignEndpoint, write=FSetSignEndpoint };

Default Value

"/sign"

Remarks

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

Data Type

String

SigningCertBytes Property (DCAuthWebServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (DCAuthWebServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle, write=FSetSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (DCAuthWebServer Component)

The number of records in the SigningChain arrays.

Syntax

__property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (DCAuthWebServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes };

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (DCAuthWebServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningChainHandle[int SigningChainIndex] = { read=FSigningChainHandle, write=FSetSigningChainHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (DCAuthWebServer Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (DCAuthWebServer Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (DCAuthWebServer Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (DCAuthWebServer Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (DCAuthWebServer Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (DCAuthWebServer Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StorageId Property (DCAuthWebServer Component)

Specifies the signing certificate residing in an alternative location.

Syntax

__property String StorageId = { read=FStorageId, write=FSetStorageId };

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

Data Type

String

TimestampServer Property (DCAuthWebServer Component)

The address of the timestamping server.

Syntax

__property String TimestampServer = { read=FTimestampServer, write=FSetTimestampServer };

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.

Data Type

String

TLSServerCertCount Property (DCAuthWebServer Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

The array indices start at 0 and end at TLSServerCertCount - 1.

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (DCAuthWebServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

TLSServerCertHandle Property (DCAuthWebServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle, write=FSetTLSServerCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (DCAuthWebServer Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (DCAuthWebServer Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxDCAuthWebServerTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxDCAuthWebServerTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (DCAuthWebServer Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (DCAuthWebServer Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxDCAuthWebServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxDCAuthWebServerTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (DCAuthWebServer Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (DCAuthWebServer Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (DCAuthWebServer Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (DCAuthWebServer Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (DCAuthWebServer Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (DCAuthWebServer Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (DCAuthWebServer Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxDCAuthWebServerTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxDCAuthWebServerTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (DCAuthWebServer Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxDCAuthWebServerTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxDCAuthWebServerTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (DCAuthWebServer Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (DCAuthWebServer Component)

Specifies the TLS mode to use.

Syntax

__property TsbxDCAuthWebServerTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxDCAuthWebServerTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (DCAuthWebServer Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (DCAuthWebServer Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (DCAuthWebServer Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UserCount Property (DCAuthWebServer Component)

The number of records in the User arrays.

Syntax

__property int UserCount = { read=FUserCount, write=FSetUserCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserUsername

The array indices start at 0 and end at UserCount - 1.

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (DCAuthWebServer Component)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

__property DynamicArray UserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData };

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (DCAuthWebServer Component)

Base path for this user in the server's file system.

Syntax

__property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath };

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserData Property (DCAuthWebServer Component)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

__property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData };

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (DCAuthWebServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (DCAuthWebServer Component)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

__property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (DCAuthWebServer Component)

Specifies the incoming speed limit for this user.

Syntax

__property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit };

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (DCAuthWebServer Component)

Specifies the outgoing speed limit for this user.

Syntax

__property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit };

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserPassword Property (DCAuthWebServer Component)

The user's authentication password.

Syntax

__property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword };

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserSharedSecret Property (DCAuthWebServer Component)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

__property DynamicArray UserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret };

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (DCAuthWebServer Component)

The registered name (login) of the user.

Syntax

__property String UserUsername[int UserIndex] = { read=FUserUsername, write=FSetUserUsername };

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

WebsiteName Property (DCAuthWebServer Component)

Specifies the web site name to use in the certificate.

Syntax

__property String WebsiteName = { read=FWebsiteName, write=FSetWebsiteName };

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

Data Type

String

Cleanup Method (DCAuthWebServer Component)

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

Syntax

void __fastcall 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

String __fastcall Config(String ConfigurationString);

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

String __fastcall DoAction(String ActionID, String ActionParams);

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

DropClient Method (DCAuthWebServer Component)

Terminates a client connection.

Syntax

void __fastcall DropClient(__int64 ConnectionId, bool 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 Component)

Enumerates the connected clients.

Syntax

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

Takes a snapshot of the connection's properties.

Syntax

void __fastcall PinClient(__int64 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 Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Start Method (DCAuthWebServer Component)

Starts the server.

Syntax

void __fastcall Start();

Remarks

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

Stop Method (DCAuthWebServer Component)

Stops the server.

Syntax

void __fastcall Stop();

Remarks

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

Accept Event (DCAuthWebServer Component)

Reports an incoming connection.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  bool Accept;
} TsbxDCAuthWebServerAcceptEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerAcceptEvent)(System::TObject* Sender, TsbxDCAuthWebServerAcceptEventParams *e);
__property TsbxDCAuthWebServerAcceptEvent OnAccept = { read=FOnAccept, write=FOnAccept };

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

typedef struct {
  __int64 ConnectionID;
  String HTTPMethod;
  String URI;
  String AuthMethod;
  String Username;
  String Password;
  bool Allow;
} TsbxDCAuthWebServerAuthAttemptEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerAuthAttemptEvent)(System::TObject* Sender, TsbxDCAuthWebServerAuthAttemptEventParams *e);
__property TsbxDCAuthWebServerAuthAttemptEvent OnAuthAttempt = { read=FOnAuthAttempt, write=FOnAuthAttempt };

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

typedef struct {
  __int64 ConnectionID;
  String RemoteAddress;
  int RemotePort;
} TsbxDCAuthWebServerConnectEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerConnectEvent)(System::TObject* Sender, TsbxDCAuthWebServerConnectEventParams *e);
__property TsbxDCAuthWebServerConnectEvent OnConnect = { read=FOnConnect, write=FOnConnect };

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

typedef struct {
  __int64 ConnectionId;
  String Value;
} TsbxDCAuthWebServerCustomParametersReceivedEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerCustomParametersReceivedEvent)(System::TObject* Sender, TsbxDCAuthWebServerCustomParametersReceivedEventParams *e);
__property TsbxDCAuthWebServerCustomParametersReceivedEvent OnCustomParametersReceived = { read=FOnCustomParametersReceived, write=FOnCustomParametersReceived };

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

typedef struct {
  __int64 ConnectionID;
} TsbxDCAuthWebServerDisconnectEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerDisconnectEvent)(System::TObject* Sender, TsbxDCAuthWebServerDisconnectEventParams *e);
__property TsbxDCAuthWebServerDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect };

Remarks

The component fires this event when a connected client disconnects.

Error Event (DCAuthWebServer Component)

Information about errors during data delivery.

Syntax

typedef struct {
  __int64 ConnectionID;
  int ErrorCode;
  bool Fatal;
  bool Remote;
  String Description;
} TsbxDCAuthWebServerErrorEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerErrorEvent)(System::TObject* Sender, TsbxDCAuthWebServerErrorEventParams *e);
__property TsbxDCAuthWebServerErrorEvent OnError = { read=FOnError, write=FOnError };

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

typedef struct {
  __int64 ConnectionID;
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxDCAuthWebServerExternalSignEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerExternalSignEvent)(System::TObject* Sender, TsbxDCAuthWebServerExternalSignEventParams *e);
__property TsbxDCAuthWebServerExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

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

typedef struct {
  __int64 ConnectionId;
  String KeyId;
  String KeySecret;
} TsbxDCAuthWebServerKeySecretNeededEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerKeySecretNeededEvent)(System::TObject* Sender, TsbxDCAuthWebServerKeySecretNeededEventParams *e);
__property TsbxDCAuthWebServerKeySecretNeededEvent OnKeySecretNeeded = { read=FOnKeySecretNeeded, write=FOnKeySecretNeeded };

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

typedef struct {
  __int64 ConnectionId;
  int LogType;
  String Details;
} TsbxDCAuthWebServerLogEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerLogEvent)(System::TObject* Sender, TsbxDCAuthWebServerLogEventParams *e);
__property TsbxDCAuthWebServerLogEvent OnLog = { read=FOnLog, write=FOnLog };

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

typedef struct {
  String EventID;
  String EventParam;
} TsbxDCAuthWebServerNotificationEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerNotificationEvent)(System::TObject* Sender, TsbxDCAuthWebServerNotificationEventParams *e);
__property TsbxDCAuthWebServerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

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

typedef struct {
  __int64 ConnectionId;
  String Name;
  String Value;
} TsbxDCAuthWebServerParameterReceivedEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerParameterReceivedEvent)(System::TObject* Sender, TsbxDCAuthWebServerParameterReceivedEventParams *e);
__property TsbxDCAuthWebServerParameterReceivedEvent OnParameterReceived = { read=FOnParameterReceived, write=FOnParameterReceived };

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

Requests a password from the application.

Syntax

typedef struct {
  String NeededFor;
  String Id;
  String Password;
  bool Cancel;
} TsbxDCAuthWebServerPasswordNeededEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerPasswordNeededEvent)(System::TObject* Sender, TsbxDCAuthWebServerPasswordNeededEventParams *e);
__property TsbxDCAuthWebServerPasswordNeededEvent OnPasswordNeeded = { read=FOnPasswordNeeded, write=FOnPasswordNeeded };

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

typedef struct {
  __int64 ConnectionId;
  String Name;
  String Value;
  bool Success;
} TsbxDCAuthWebServerReadOptionEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerReadOptionEvent)(System::TObject* Sender, TsbxDCAuthWebServerReadOptionEventParams *e);
__property TsbxDCAuthWebServerReadOptionEvent OnReadOption = { read=FOnReadOption, write=FOnReadOption };

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

typedef struct {
  __int64 ConnectionId;
  String CommonName;
  String KeyID;
  String KeyUsage;
  String Fingerprint;
  String StoreType;
} TsbxDCAuthWebServerSelectCertEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerSelectCertEvent)(System::TObject* Sender, TsbxDCAuthWebServerSelectCertEventParams *e);
__property TsbxDCAuthWebServerSelectCertEvent OnSelectCert = { read=FOnSelectCert, write=FOnSelectCert };

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

typedef struct {
  __int64 ConnectionId;
  int Method;
  String HashAlgorithm;
  DynamicArray Hash;
  String KeyID;
  String Pars;
  String MethodPars;
  bool Allow;
} TsbxDCAuthWebServerSignRequestEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerSignRequestEvent)(System::TObject* Sender, TsbxDCAuthWebServerSignRequestEventParams *e);
__property TsbxDCAuthWebServerSignRequestEvent OnSignRequest = { read=FOnSignRequest, write=FOnSignRequest };

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

typedef struct {
  __int64 ConnectionId;
  int Method;
  String HashAlgorithm;
  DynamicArray Hash;
  String KeyID;
  String Pars;
  String MethodPars;
  DynamicArray Signature;
} TsbxDCAuthWebServerSignRequestCompletedEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerSignRequestCompletedEvent)(System::TObject* Sender, TsbxDCAuthWebServerSignRequestCompletedEventParams *e);
__property TsbxDCAuthWebServerSignRequestCompletedEvent OnSignRequestCompleted = { read=FOnSignRequestCompleted, write=FOnSignRequestCompleted };

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

typedef struct {
  String TSA;
  String TimestampRequest;
  String TimestampResponse;
  bool SuppressDefault;
} TsbxDCAuthWebServerTimestampRequestEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTimestampRequestEvent)(System::TObject* Sender, TsbxDCAuthWebServerTimestampRequestEventParams *e);
__property TsbxDCAuthWebServerTimestampRequestEvent OnTimestampRequest = { read=FOnTimestampRequest, write=FOnTimestampRequest };

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

typedef struct {
  __int64 ConnectionID;
  bool Accept;
} TsbxDCAuthWebServerTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTLSCertValidateEvent)(System::TObject* Sender, TsbxDCAuthWebServerTLSCertValidateEventParams *e);
__property TsbxDCAuthWebServerTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

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

typedef struct {
  __int64 ConnectionID;
} TsbxDCAuthWebServerTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTLSEstablishedEvent)(System::TObject* Sender, TsbxDCAuthWebServerTLSEstablishedEventParams *e);
__property TsbxDCAuthWebServerTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

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

typedef struct {
  __int64 ConnectionID;
  String ServerName;
  bool Abort;
} TsbxDCAuthWebServerTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTLSHandshakeEvent)(System::TObject* Sender, TsbxDCAuthWebServerTLSHandshakeEventParams *e);
__property TsbxDCAuthWebServerTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

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

typedef struct {
  __int64 ConnectionID;
  String Identity;
  String PSK;
  String Ciphersuite;
} TsbxDCAuthWebServerTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTLSPSKEvent)(System::TObject* Sender, TsbxDCAuthWebServerTLSPSKEventParams *e);
__property TsbxDCAuthWebServerTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

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

typedef struct {
  __int64 ConnectionID;
} TsbxDCAuthWebServerTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerTLSShutdownEvent)(System::TObject* Sender, TsbxDCAuthWebServerTLSShutdownEventParams *e);
__property TsbxDCAuthWebServerTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

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

typedef struct {
  __int64 ConnectionId;
  String Name;
  String Value;
} TsbxDCAuthWebServerWriteOptionEventParams;
typedef void __fastcall (__closure *TsbxDCAuthWebServerWriteOptionEvent)(System::TObject* Sender, TsbxDCAuthWebServerWriteOptionEventParams *e);
__property TsbxDCAuthWebServerWriteOptionEvent OnWriteOption = { read=FOnWriteOption, write=FOnWriteOption };

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.

Config Settings (DCAuthWebServer Component)

The component 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 component, access to these internal properties is provided through the Config method.

DCAuthWebServer Config Settings

Base Config Settings

Trappable Errors (DCAuthWebServer Component)