DCAuthWebServer Component
Properties Methods Events Config Settings Errors
The DCAuthWebServer Component offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.
Syntax
nsoftware.SecureBlackbox.Dcauthwebserver
Remarks
DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific Port or a port chosen between PortRangeFrom and PortRangeTo. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Active | Indicates whether the server is active and is listening to new connections. |
| AllowOrigin | Specifies the content of AllowOrigin header of the service reply. |
| AuthBasic | Enables or disables basic authentication |
| AuthDigest | Enables or disables digest authentication |
| AuthDigestExpire | Specifies digest expiration time for digest authentication |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication |
| BoundPort | Indicates the bound listening port. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| ErrorOrigin | Indicates the endpoint where the error originates from. |
| ErrorSeverity | The severity of the error that happened. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FIPSMode | Reserved. |
| HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
| Host | The host to bind the listening port to. |
| KeyId | Specifies the KeyID of the pre-shared authentication key. |
| KeySecret | The pre-shared authentication key. |
| PinnedClient | Populates the pinned client details. |
| PinnedClientChain | Contains the certificate chain of the pinned client. |
| Policies | Specifies the policies to use when processing requests. |
| Port | Specifies the port number to listen for connections on. |
| PortRangeFrom | Specifies the lower limit of the listening port range for incoming connections. |
| PortRangeTo | Specifies the upper limit of the listening port range for incoming connections. |
| ServerCertificates | The server's TLS certificates. |
| SessionTimeout | Specifies the default session timeout value in milliseconds. |
| SignEndpoint | The signing service endpoint |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
| SocketSettings | Manages network connection settings. |
| StorageId | Specifies the signing certificate residing in an alternative location |
| TimestampServer | The address of the timestamping server. |
| TLSSettings | Manages TLS layer settings. |
| Users | Provides a list of registered users. |
| WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| DropClient | Terminates a client connection. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| Start | Starts the server. |
| Stop | Stops the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Accept | Reports an incoming connection. |
| AuthAttempt | Fires when a connected client makes an authentication attempt. |
| Connect | Reports an accepted connection. |
| CustomParametersReceived | Passes custom request parameters to the application. |
| Disconnect | Fires to report a disconnected client. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| KeySecretNeeded | Requests the key secret from the application. |
| Log | Reports a single log line. |
| Notification | This event notifies the application about an underlying control flow event. |
| ParameterReceived | Passes a standard request parameter to the user code. |
| PasswordNeeded | Requests a password from the application. |
| ReadOption | Fires when the client sends in a read option request. |
| SelectCert | Requests certificate selection criteria from the application. |
| SignRequest | This event signifies the processing of an atomic signing request. |
| SignRequestCompleted | This event signifies completion of the processing of an atomic signing request. |
| TimestampRequest | Fires when the component is ready to request a timestamp from an external TSA. |
| TLSCertValidate | Fires when a client certificate needs to be validated. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
| WriteOption | Fires when the client sends in a write option request. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (DCAuthWebServer Component)
Indicates whether the server is active and is listening to new connections.
Syntax
Default Value
False
Remarks
This read-only property returns True if the server is listening to incoming connections.
This property is read-only and not available at design time.
AllowOrigin Property (DCAuthWebServer Component)
Specifies the content of AllowOrigin header of the service reply.
Syntax
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.
AuthBasic Property (DCAuthWebServer Component)
Enables or disables basic authentication
Syntax
Default Value
False
Remarks
Use this property to enable or disable basic user authentication in the HTTP server.
AuthDigest Property (DCAuthWebServer Component)
Enables or disables digest authentication
Syntax
Default Value
False
Remarks
Use this property to enable or disable digest-based user authentication in the HTTP server.
AuthDigestExpire Property (DCAuthWebServer Component)
Specifies digest expiration time for digest authentication
Syntax
Default Value
20
Remarks
Use this property to specify the digest expiration time for digest authentication, in seconds. This is effectively the maximal time between the first and the second steps of the authentication process.
AuthRealm Property (DCAuthWebServer Component)
Specifies authentication realm for digest and NTLM authentication
Syntax
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
BoundPort Property (DCAuthWebServer Component)
Indicates the bound listening port.
Syntax
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.
ClientAuth Property (DCAuthWebServer Component)
Enables or disables certificate-based client authentication.
Syntax
public DcauthwebserverClientAuths ClientAuth { get; set; }
enum DcauthwebserverClientAuths { ccatNoAuth, ccatRequestCert, ccatRequireCert }
Public Property ClientAuth As DcauthwebserverClientAuths
Enum DcauthwebserverClientAuths ccatNoAuth ccatRequestCert ccatRequireCert End Enum
Default Value
0
Remarks
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
ErrorOrigin Property (DCAuthWebServer Component)
Indicates the endpoint where the error originates from.
Syntax
public DcauthwebserverErrorOrigins ErrorOrigin { get; set; }
enum DcauthwebserverErrorOrigins { eoLocal, eoRemote }
Public Property ErrorOrigin As DcauthwebserverErrorOrigins
Enum DcauthwebserverErrorOrigins eoLocal eoRemote End Enum
Default Value
0
Remarks
Use this property to establish whether the reported error originates from a local or remote endpoint.
| eoLocal | 0 | |
| eoRemote | 1 |
This property is not available at design time.
ErrorSeverity Property (DCAuthWebServer Component)
The severity of the error that happened.
Syntax
public DcauthwebserverErrorSeverities ErrorSeverity { get; set; }
enum DcauthwebserverErrorSeverities { esInfo, esWarning, esFatal }
Public Property ErrorSeverity As DcauthwebserverErrorSeverities
Enum DcauthwebserverErrorSeverities esInfo esWarning esFatal End Enum
Default Value
1
Remarks
Use this property to establish whether the error is fatal.
| esWarning | 1 | |
| esFatal | 2 |
This property is not available at design time.
ExternalCrypto Property (DCAuthWebServer Component)
Provides access to external signing and DC parameters.
Syntax
public ExternalCrypto ExternalCrypto { get; }
Public ReadOnly Property ExternalCrypto As ExternalCrypto
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).
This property is read-only.
FIPSMode Property (DCAuthWebServer Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
HandshakeTimeout Property (DCAuthWebServer Component)
Specifies the handshake timeout in milliseconds.
Syntax
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Host Property (DCAuthWebServer Component)
The host to bind the listening port to.
Syntax
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections.
KeyId Property (DCAuthWebServer Component)
Specifies the KeyID of the pre-shared authentication key.
Syntax
Default Value
""
Remarks
If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the KeySecret property. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
KeySecret Property (DCAuthWebServer Component)
The pre-shared authentication key.
Syntax
Default Value
""
Remarks
If processing requests from a single known party, assign the key you pre-shared with them to this property. Use KeyId property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
PinnedClient Property (DCAuthWebServer Component)
Populates the pinned client details.
Syntax
public TLSClientEntry PinnedClient { get; }
Public ReadOnly Property PinnedClient As TLSClientEntry
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
This property is read-only and not available at design time.
PinnedClientChain Property (DCAuthWebServer Component)
Contains the certificate chain of the pinned client.
Syntax
public CertificateList PinnedClientChain { get; }
Public ReadOnly Property PinnedClientChain As CertificateList
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
This property is read-only and not available at design time.
Policies Property (DCAuthWebServer Component)
Specifies the policies to use when processing requests.
Syntax
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:
| aspAcceptUnsignedRequests | 1 | Allows the component to accept unauthenticated messages (those not signed with KeyID/KeySecret). Use with extreme care. |
| aspIgnorePKCS1Requests | 2 | Ignore requests of PKCS1 type. |
| aspIgnorePKCS7Requests | 4 | Ignore requests of PKCS7 type. |
| aspIgnoreRequestTSA | 8 | Ignore the TSA URL provided in the request, and either stick with the service provided via TimestampServer property, or not timestamp the message altogether. |
| aspIgnoreRequestSigningTime | 16 | Ignore the signing time included in the request. |
| aspIgnoreRequestPKCS7Settings | 32 | Ignore auxiliary PKCS7 settings (content type, attributes) included in the request. |
| aspAlwaysTimestampSigs | 64 | Timestamp created signatures (PKCS7 only), even if the client did not request it. |
This property is not available at design time.
Port Property (DCAuthWebServer Component)
Specifies the port number to listen for connections on.
Syntax
Default Value
80
Remarks
Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.
Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.
PortRangeFrom Property (DCAuthWebServer Component)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
Default Value
0
Remarks
Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
PortRangeTo Property (DCAuthWebServer Component)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
Default Value
0
Remarks
Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
ServerCertificates Property (DCAuthWebServer Component)
The server's TLS certificates.
Syntax
public CertificateList ServerCertificates { get; }
Public Property ServerCertificates As CertificateList
Remarks
Use this property to provide a list of TLS certificates for the server endpoint.
A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.
The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different ciphersuite preferences.
This property is not available at design time.
SessionTimeout Property (DCAuthWebServer Component)
Specifies the default session timeout value in milliseconds.
Syntax
Default Value
360000
Remarks
Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.
SignEndpoint Property (DCAuthWebServer Component)
The signing service endpoint
Syntax
Default Value
"/sign"
Remarks
Use this property to specify the signing service end point on the server.
SigningCertificate Property (DCAuthWebServer Component)
The certificate to be used for signing.
Syntax
public Certificate SigningCertificate { get; set; }
Public Property SigningCertificate As Certificate
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
SigningChain Property (DCAuthWebServer Component)
The signing certificate chain.
Syntax
public CertificateList SigningChain { get; }
Public Property SigningChain As CertificateList
Remarks
Use this property to provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
SocketSettings Property (DCAuthWebServer Component)
Manages network connection settings.
Syntax
public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
StorageId Property (DCAuthWebServer Component)
Specifies the signing certificate residing in an alternative location
Syntax
Default Value
""
Remarks
Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.
Example 1: The certificate resides on a PKCS#11 device
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1
Example 2: The certificate resides in a system store
system://localmachine@/?store=MY
You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:
- cn: the common name of the certificate subject.
- keyid: the unique identifier included in subject key identifier extension of the certificate.
- keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
- fingerprint: the fingerprint of the certificate.
Example 3: selecting the certificate with a given fingerprint:
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344
TimestampServer Property (DCAuthWebServer Component)
The address of the timestamping server.
Syntax
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
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.
All the parameters are optional.
TLSSettings Property (DCAuthWebServer Component)
Manages TLS layer settings.
Syntax
public TLSSettings TLSSettings { get; }
Public ReadOnly Property TLSSettings As TLSSettings
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Users Property (DCAuthWebServer Component)
Provides a list of registered users.
Syntax
public UserAccountList Users { get; }
Public Property Users As UserAccountList
Remarks
Assign a list of 'known' users to this property to automate authentication handling by the component.
This property is not available at design time.
WebsiteName Property (DCAuthWebServer Component)
Specifies the web site name to use in the certificate.
Syntax
Default Value
"SecureBlackbox"
Remarks
If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.
Config Method (DCAuthWebServer Component)
Sets or retrieves a configuration setting.
Syntax
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
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
DropClient Method (DCAuthWebServer Component)
Terminates a client connection.
Syntax
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
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
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
Start Method (DCAuthWebServer Component)
Starts the server.
Syntax
public void Start();
Public Sub Start()
Remarks
Use this method to activate the server and start listening to incoming connections.
Stop Method (DCAuthWebServer Component)
Stops the server.
Syntax
public void Stop();
Public Sub Stop()
Remarks
Call this method to stop listening to incoming connections and deactivate the server.
Accept Event (DCAuthWebServer Component)
Reports an incoming connection.
Syntax
public event OnAcceptHandler OnAccept; public delegate void OnAcceptHandler(object sender, DcauthwebserverAcceptEventArgs e); public class DcauthwebserverAcceptEventArgs : EventArgs { public string RemoteAddress { get; } public int RemotePort { get; } public bool Accept { get; set; } }
Public Event OnAccept As OnAcceptHandler Public Delegate Sub OnAcceptHandler(sender As Object, e As DcauthwebserverAcceptEventArgs) Public Class DcauthwebserverAcceptEventArgs Inherits EventArgs Public ReadOnly Property RemoteAddress As String Public ReadOnly Property RemotePort As Integer Public Property Accept As Boolean End Class
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
AuthAttempt Event (DCAuthWebServer Component)
Fires when a connected client makes an authentication attempt.
Syntax
public event OnAuthAttemptHandler OnAuthAttempt; public delegate void OnAuthAttemptHandler(object sender, DcauthwebserverAuthAttemptEventArgs e); public class DcauthwebserverAuthAttemptEventArgs : EventArgs { public long ConnectionID { get; } public string HTTPMethod { get; } public string URI { get; } public string AuthMethod { get; } public string Username { get; } public string Password { get; } public bool Allow { get; set; } }
Public Event OnAuthAttempt As OnAuthAttemptHandler Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As DcauthwebserverAuthAttemptEventArgs) Public Class DcauthwebserverAuthAttemptEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property HTTPMethod As String Public ReadOnly Property URI As String Public ReadOnly Property AuthMethod As String Public ReadOnly Property Username As String Public ReadOnly Property Password As String Public Property Allow As Boolean End Class
Remarks
The component fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.
ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.
Connect Event (DCAuthWebServer Component)
Reports an accepted connection.
Syntax
public event OnConnectHandler OnConnect; public delegate void OnConnectHandler(object sender, DcauthwebserverConnectEventArgs e); public class DcauthwebserverConnectEventArgs : EventArgs { public long ConnectionID { get; } public string RemoteAddress { get; } public int RemotePort { get; } }
Public Event OnConnect As OnConnectHandler Public Delegate Sub OnConnectHandler(sender As Object, e As DcauthwebserverConnectEventArgs) Public Class DcauthwebserverConnectEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property RemoteAddress As String Public ReadOnly Property RemotePort As Integer End Class
Remarks
The component fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.
CustomParametersReceived Event (DCAuthWebServer Component)
Passes custom request parameters to the application.
Syntax
public event OnCustomParametersReceivedHandler OnCustomParametersReceived; public delegate void OnCustomParametersReceivedHandler(object sender, DcauthwebserverCustomParametersReceivedEventArgs e); public class DcauthwebserverCustomParametersReceivedEventArgs : EventArgs { public long ConnectionId { get; } public string Value { get; } }
Public Event OnCustomParametersReceived As OnCustomParametersReceivedHandler Public Delegate Sub OnCustomParametersReceivedHandler(sender As Object, e As DcauthwebserverCustomParametersReceivedEventArgs) Public Class DcauthwebserverCustomParametersReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Value As String End Class
Remarks
Subscribe to this event to access custom signing parameters supplied by the signer in their request. The Value string contains the parameters as included by the requestor.
Disconnect Event (DCAuthWebServer Component)
Fires to report a disconnected client.
Syntax
public event OnDisconnectHandler OnDisconnect; public delegate void OnDisconnectHandler(object sender, DcauthwebserverDisconnectEventArgs e); public class DcauthwebserverDisconnectEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnDisconnect As OnDisconnectHandler Public Delegate Sub OnDisconnectHandler(sender As Object, e As DcauthwebserverDisconnectEventArgs) Public Class DcauthwebserverDisconnectEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
The component fires this event when a connected client disconnects.
Error Event (DCAuthWebServer Component)
Information about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, DcauthwebserverErrorEventArgs e); public class DcauthwebserverErrorEventArgs : EventArgs { public long ConnectionID { get; } public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As DcauthwebserverErrorEventArgs) Public Class DcauthwebserverErrorEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.
ExternalSign Event (DCAuthWebServer Component)
Handles remote or external signing initiated by the server protocol.
Syntax
public event OnExternalSignHandler OnExternalSign; public delegate void OnExternalSignHandler(object sender, DcauthwebserverExternalSignEventArgs e); public class DcauthwebserverExternalSignEventArgs : EventArgs { public long ConnectionID { get; } public string OperationId { get; } public string HashAlgorithm { get; } public string Pars { get; } public string Data { get; } public string SignedData { get; set; } }
Public Event OnExternalSign As OnExternalSignHandler Public Delegate Sub OnExternalSignHandler(sender As Object, e As DcauthwebserverExternalSignEventArgs) Public Class DcauthwebserverExternalSignEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property OperationId As String Public ReadOnly Property HashAlgorithm As String Public ReadOnly Property Pars As String Public ReadOnly Property Data As String Public Property SignedData As String End Class
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via 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 contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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 a .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
public event OnKeySecretNeededHandler OnKeySecretNeeded; public delegate void OnKeySecretNeededHandler(object sender, DcauthwebserverKeySecretNeededEventArgs e); public class DcauthwebserverKeySecretNeededEventArgs : EventArgs { public long ConnectionId { get; } public string KeyId { get; } public string KeySecret { get; set; } }
Public Event OnKeySecretNeeded As OnKeySecretNeededHandler Public Delegate Sub OnKeySecretNeededHandler(sender As Object, e As DcauthwebserverKeySecretNeededEventArgs) Public Class DcauthwebserverKeySecretNeededEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property KeyId As String Public Property KeySecret As String End Class
Remarks
Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the KeyId, a non-secret unique key identifier, and the KeySecret, shared by the parties, which should be kept private. This event is an alternative for KeySecret property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via KeyId and KeySecret properties would be an easier route.
Log Event (DCAuthWebServer Component)
Reports a single log line.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, DcauthwebserverLogEventArgs e); public class DcauthwebserverLogEventArgs : EventArgs { public long ConnectionId { get; } public int LogType { get; } public string Details { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As DcauthwebserverLogEventArgs) Public Class DcauthwebserverLogEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property LogType As Integer Public ReadOnly Property Details As String End Class
Remarks
This event is fired repeatedly during the component's work to inform the application about the flow of the signing process. The application may use this event to create an operation log.
Notification Event (DCAuthWebServer Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, DcauthwebserverNotificationEventArgs e); public class DcauthwebserverNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As DcauthwebserverNotificationEventArgs) Public Class DcauthwebserverNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in 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
public event OnParameterReceivedHandler OnParameterReceived; public delegate void OnParameterReceivedHandler(object sender, DcauthwebserverParameterReceivedEventArgs e); public class DcauthwebserverParameterReceivedEventArgs : EventArgs { public long ConnectionId { get; } public string Name { get; } public string Value { get; } }
Public Event OnParameterReceived As OnParameterReceivedHandler Public Delegate Sub OnParameterReceivedHandler(sender As Object, e As DcauthwebserverParameterReceivedEventArgs) Public Class DcauthwebserverParameterReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Name As String Public ReadOnly Property Value As String End Class
Remarks
This event is fired when one of 'standard' protocol parameters has been found in the request:
- SessionID
- DataURL
- GoURL
- Token
- PKCS11Libraries
- AllowFileStorage
- AllowTokenStorage
- AllowWindowsStorage
- AllowOSStorage
PasswordNeeded Event (DCAuthWebServer Component)
Requests a password from the application.
Syntax
public event OnPasswordNeededHandler OnPasswordNeeded; public delegate void OnPasswordNeededHandler(object sender, DcauthwebserverPasswordNeededEventArgs e); public class DcauthwebserverPasswordNeededEventArgs : EventArgs { public string NeededFor { get; } public string Id { get; } public string Password { get; set; } public bool Cancel { get; set; } }
Public Event OnPasswordNeeded As OnPasswordNeededHandler Public Delegate Sub OnPasswordNeededHandler(sender As Object, e As DcauthwebserverPasswordNeededEventArgs) Public Class DcauthwebserverPasswordNeededEventArgs Inherits EventArgs Public ReadOnly Property NeededFor As String Public ReadOnly Property Id As String Public Property Password As String Public Property Cancel As Boolean End Class
Remarks
Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.
ReadOption Event (DCAuthWebServer Component)
Fires when the client sends in a read option request.
Syntax
public event OnReadOptionHandler OnReadOption; public delegate void OnReadOptionHandler(object sender, DcauthwebserverReadOptionEventArgs e); public class DcauthwebserverReadOptionEventArgs : EventArgs { public long ConnectionId { get; } public string Name { get; } public string Value { get; set; } public bool Success { get; set; } }
Public Event OnReadOption As OnReadOptionHandler Public Delegate Sub OnReadOptionHandler(sender As Object, e As DcauthwebserverReadOptionEventArgs) Public Class DcauthwebserverReadOptionEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Name As String Public Property Value As String Public Property Success As Boolean End Class
Remarks
Subscribe to this event to respond to the clients' read option requests. The handler should retrieve the value of the requested option from a local configuration setting and assign it to the Value parameter.
SelectCert Event (DCAuthWebServer Component)
Requests certificate selection criteria from the application.
Syntax
public event OnSelectCertHandler OnSelectCert; public delegate void OnSelectCertHandler(object sender, DcauthwebserverSelectCertEventArgs e); public class DcauthwebserverSelectCertEventArgs : EventArgs { public long ConnectionId { get; } public string CommonName { get; set; } public string KeyID { get; set; } public string KeyUsage { get; set; } public string Fingerprint { get; set; } public string StoreType { get; set; } }
Public Event OnSelectCert As OnSelectCertHandler Public Delegate Sub OnSelectCertHandler(sender As Object, e As DcauthwebserverSelectCertEventArgs) Public Class DcauthwebserverSelectCertEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public Property CommonName As String Public Property KeyID As String Public Property KeyUsage As String Public Property Fingerprint As String Public Property StoreType As String End Class
Remarks
Subscribe to this event to provide signing certificate details on the fly, right before the hash is signed.
SignRequest Event (DCAuthWebServer Component)
This event signifies the processing of an atomic signing request.
Syntax
public event OnSignRequestHandler OnSignRequest; public delegate void OnSignRequestHandler(object sender, DcauthwebserverSignRequestEventArgs e); public class DcauthwebserverSignRequestEventArgs : EventArgs { public long ConnectionId { get; } public int Method { get; } public string HashAlgorithm { get; } public byte[] Hash { get; } public string KeyID { get; } public string Pars { get; } public string MethodPars { get; } public bool Allow { get; set; } }
Public Event OnSignRequest As OnSignRequestHandler Public Delegate Sub OnSignRequestHandler(sender As Object, e As DcauthwebserverSignRequestEventArgs) Public Class DcauthwebserverSignRequestEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Method As Integer Public ReadOnly Property HashAlgorithm As String Public ReadOnly Property Hash As Byte() Public ReadOnly Property KeyID As String Public ReadOnly Property Pars As String Public ReadOnly Property MethodPars As String Public Property Allow As Boolean End Class
Remarks
Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The Method parameter specifies the async signing method requested by the client:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
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
public event OnSignRequestCompletedHandler OnSignRequestCompleted; public delegate void OnSignRequestCompletedHandler(object sender, DcauthwebserverSignRequestCompletedEventArgs e); public class DcauthwebserverSignRequestCompletedEventArgs : EventArgs { public long ConnectionId { get; } public int Method { get; } public string HashAlgorithm { get; } public byte[] Hash { get; } public string KeyID { get; } public string Pars { get; } public string MethodPars { get; } public byte[] Signature { get; } }
Public Event OnSignRequestCompleted As OnSignRequestCompletedHandler Public Delegate Sub OnSignRequestCompletedHandler(sender As Object, e As DcauthwebserverSignRequestCompletedEventArgs) Public Class DcauthwebserverSignRequestCompletedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Method As Integer Public ReadOnly Property HashAlgorithm As String Public ReadOnly Property Hash As Byte() Public ReadOnly Property KeyID As String Public ReadOnly Property Pars As String Public ReadOnly Property MethodPars As String Public ReadOnly Property Signature As Byte() End Class
Remarks
Use this event to track completion of signing request processing. The Hash parameter contains the hash that is signed, as supplied by the requestor, and the Signature parameter contains the resulting cryptographic signature. The Username parameter matches the parameter in SignRequest event.
TimestampRequest Event (DCAuthWebServer Component)
Fires when the component is ready to request a timestamp from an external TSA.
Syntax
public event OnTimestampRequestHandler OnTimestampRequest; public delegate void OnTimestampRequestHandler(object sender, DcauthwebserverTimestampRequestEventArgs e); public class DcauthwebserverTimestampRequestEventArgs : EventArgs { public string TSA { get; } public string TimestampRequest { get; } public string TimestampResponse { get; set; } public bool SuppressDefault { get; set; } }
Public Event OnTimestampRequest As OnTimestampRequestHandler Public Delegate Sub OnTimestampRequestHandler(sender As Object, e As DcauthwebserverTimestampRequestEventArgs) Public Class DcauthwebserverTimestampRequestEventArgs Inherits EventArgs Public ReadOnly Property TSA As String Public ReadOnly Property TimestampRequest As String Public Property TimestampResponse As String Public Property SuppressDefault As Boolean End Class
Remarks
Subscribe to this event to be 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 TimestampServer property. Set 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
public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, DcauthwebserverTLSCertValidateEventArgs e); public class DcauthwebserverTLSCertValidateEventArgs : EventArgs { public long ConnectionID { get; } public bool Accept { get; set; } }
Public Event OnTLSCertValidate As OnTLSCertValidateHandler Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As DcauthwebserverTLSCertValidateEventArgs) Public Class DcauthwebserverTLSCertValidateEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public Property Accept As Boolean End Class
Remarks
The component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (DCAuthWebServer Component)
Reports the setup of a TLS session.
Syntax
public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, DcauthwebserverTLSEstablishedEventArgs e); public class DcauthwebserverTLSEstablishedEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnTLSEstablished As OnTLSEstablishedHandler Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As DcauthwebserverTLSEstablishedEventArgs) Public Class DcauthwebserverTLSEstablishedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (DCAuthWebServer Component)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, DcauthwebserverTLSHandshakeEventArgs e); public class DcauthwebserverTLSHandshakeEventArgs : EventArgs { public long ConnectionID { get; } public string ServerName { get; } public bool Abort { get; set; } }
Public Event OnTLSHandshake As OnTLSHandshakeHandler Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As DcauthwebserverTLSHandshakeEventArgs) Public Class DcauthwebserverTLSHandshakeEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property ServerName As String Public Property Abort As Boolean End Class
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (DCAuthWebServer Component)
Requests a pre-shared key for TLS-PSK.
Syntax
public event OnTLSPSKHandler OnTLSPSK; public delegate void OnTLSPSKHandler(object sender, DcauthwebserverTLSPSKEventArgs e); public class DcauthwebserverTLSPSKEventArgs : EventArgs { public long ConnectionID { get; } public string Identity { get; } public string PSK { get; set; } public string Ciphersuite { get; set; } }
Public Event OnTLSPSK As OnTLSPSKHandler Public Delegate Sub OnTLSPSKHandler(sender As Object, e As DcauthwebserverTLSPSKEventArgs) Public Class DcauthwebserverTLSPSKEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property Identity As String Public Property PSK As String Public Property Ciphersuite As String End Class
Remarks
The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the ciphersuite associated with that identity and their key.
TLSShutdown Event (DCAuthWebServer Component)
Reports closure of a TLS session.
Syntax
public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, DcauthwebserverTLSShutdownEventArgs e); public class DcauthwebserverTLSShutdownEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnTLSShutdown As OnTLSShutdownHandler Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As DcauthwebserverTLSShutdownEventArgs) Public Class DcauthwebserverTLSShutdownEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
WriteOption Event (DCAuthWebServer Component)
Fires when the client sends in a write option request.
Syntax
public event OnWriteOptionHandler OnWriteOption; public delegate void OnWriteOptionHandler(object sender, DcauthwebserverWriteOptionEventArgs e); public class DcauthwebserverWriteOptionEventArgs : EventArgs { public long ConnectionId { get; } public string Name { get; } public string Value { get; } }
Public Event OnWriteOption As OnWriteOptionHandler Public Delegate Sub OnWriteOptionHandler(sender As Object, e As DcauthwebserverWriteOptionEventArgs) Public Class DcauthwebserverWriteOptionEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property Name As String Public ReadOnly Property Value As String End Class
Remarks
Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
Bytes Byte() |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA Boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID Byte() |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint Byte() |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits Integer |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint Byte() |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage Integer |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid Boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck Boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin Integer |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes Byte() |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists Boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable Boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes Byte() |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned Boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber Byte() |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID Byte() |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public Certificate(byte[] bytes, int startIndex, int count, string password);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
public Certificate(byte[] bytes, int startIndex, int count);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
public Certificate(string path, string password);
Public Certificate(ByVal Path As String, ByVal Password As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
public Certificate(string certPath, string keyPath, string password);
Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
public Certificate(string path);
Public Certificate(ByVal Path As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate(System.IO.Stream stream);
Public Certificate(ByVal Stream As System.IO.Stream)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate(System.IO.Stream stream, string password);
Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);
Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.
public Certificate();
Public Certificate()
Creates a new object with default field values.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
|
AsyncDocumentID String |
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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CustomParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ExternalHashCalculation Boolean |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyID String |
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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeySecret String |
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 KeyID topic. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Method AsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Mode ExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
public ExternalCrypto();
Public ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
DNSMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
DNSPort Integer |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
DNSQueryTimeout Integer |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
DNSServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
DNSTotalTimeout Integer |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
IncomingSpeedLimit Integer |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
LocalAddress String |
The local network interface to bind the socket to. |
||||||||
|
LocalPort Integer |
The local port number to bind the socket to. |
||||||||
|
OutgoingSpeedLimit Integer |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
Timeout Integer |
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). |
||||||||
|
UseIPv6 Boolean |
Enables or disables IP protocol version 6. |
Constructors
public SocketSettings();
Public SocketSettings()
Creates a new SocketSettings object.
TLSClientEntry Type
A container for a connected TLS client's details.
Remarks
Use this property to access the details of a particular connected client.
Fields
|
Address String |
The client's IP address. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationDetails Integer |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthenticated Boolean |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
DigestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
EncryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ID Long |
The client connection's unique identifier. This value is used throughout to refer to a particular client connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeKeyBits Integer |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
NamedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PFSCipher Boolean |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Port Integer |
The remote port of the client connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBits Integer |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ResumedSession Boolean |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SecureConnection Boolean |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricBlockSize Integer |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricKeyBits Integer |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesReceived Long |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesSent Long |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public TLSClientEntry();
Public TLSClientEntry()
Creates a new TLSClientEntry object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
AutoValidateCertificates Boolean |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
BaseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
Ciphersuites String |
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 that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. 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:
|
|||||||||||||||||||||||||||||||||
|
ECCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
Extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
ForceResumeIfDestinationChanges Boolean |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
PreSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
PreSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
RenegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
RevocationCheck RevocationCheckKinds |
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. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
SSLOptions Integer |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
UseExtendedMasterSecret Boolean |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
UseSessionResumption Boolean |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
Versions Integer |
Th SSL/TLS versions to enable by default.
|
Constructors
public TLSSettings();
Public TLSSettings()
Creates a new TLSSettings object.
UserAccount Type
A container for user account information.
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
|
AssociatedData Byte() |
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
|||||||||
|
BasePath String |
Base path for this user in the server's file system. |
|||||||||
|
Cert Byte() |
Contains the user's certificate. |
|||||||||
|
Data String |
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
|||||||||
|
HashAlgorithm String |
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:
|
|||||||||
|
IncomingSpeedLimit Integer |
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation". |
|||||||||
|
OtpAlgorithm OTPAlgorithms |
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
|
|||||||||
|
OtpValue Integer |
The user's time interval (TOTP) or Counter (HOTP). |
|||||||||
|
OutgoingSpeedLimit Integer |
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation". |
|||||||||
|
Password String |
The user's authentication password. |
|||||||||
|
PasswordLen Integer |
Specifies the length of the user's OTP password. |
|||||||||
|
SharedSecret Byte() |
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. |
|||||||||
|
SSHKey Byte() |
Contains the user's SSH key. |
|||||||||
|
Username String |
The registered name (login) of the user. |
Constructors
public UserAccount();
Public UserAccount()
Creates a new UserAccount object.
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.Base Config Settings
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
|||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component.
Supported values are:
|
|||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. | |||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | |||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
|||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global". | |||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. | |||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | |||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
|||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
|||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
|||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | |||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | |||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
|||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | |||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | |||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | |||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | |||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | |||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
|||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |