DCAuthWebServer Component
Properties Methods Events Config Settings Errors
The DCAuthWebServer Class offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.
Syntax
secureblackbox.DCAuthWebServer
Remarks
DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific Port or a port chosen between PortRangeFrom and PortRangeTo. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.
Property List
The following is the full list of the properties of the 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. |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
| AuthTypes | Defines allowed HTTP authentication types. |
| BoundPort | Indicates the bound listening port. |
| ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| ExternalCryptoMethod | Specifies the asynchronous signing method. |
| ExternalCryptoMode | Specifies the external cryptography mode. |
| ExternalCryptoPublicKeyAlgorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| 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. |
| PinnedClientAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
| PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
| PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
| PinnedClientCiphersuite | The cipher suite employed by this connection. |
| PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
| PinnedClientClientAuthRequested | Specifies whether client authentication was requested during this connection. |
| PinnedClientConnectionEstablished | Indicates whether the connection has been established fully. |
| PinnedClientConnectionID | The unique identifier assigned to this connection. |
| PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
| PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| PinnedClientExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
| PinnedClientGroup | The elliptic curve used in this connection. |
| PinnedClientID | The client connection's unique identifier. |
| PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
| PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
| PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| PinnedClientPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
| PinnedClientPublicKeyBits | The length of the public key. |
| PinnedClientRemoteAddress | The client's IP address. |
| PinnedClientRemotePort | The remote port of the client connection. |
| PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
| PinnedClientServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
| PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
| PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
| PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
| PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
| PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
| PinnedClientValidationLog | Contains the server certificate's chain validation log. |
| PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
| PinnedClientCertBytes | Returns the raw certificate data in DER format. |
| PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| PinnedClientCertIssuerRDN | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| PinnedClientCertKeyBits | Returns the length of the public key in bits. |
| PinnedClientCertKeyFingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| PinnedClientCertSerialNumber | Returns the certificate's serial number. |
| PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| PinnedClientCertSubjectKeyID | Contains a unique identifier of the certificate's cryptographic key. |
| PinnedClientCertSubjectRDN | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
| 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. |
| SessionTimeout | Specifies the default session timeout value in milliseconds. |
| SignEndpoint | The signing service endpoint. |
| SigningCertBytes | Returns the raw certificate data in DER format. |
| SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SigningChainCount | The number of records in the SigningChain arrays. |
| SigningChainBytes | Returns the raw certificate data in DER format. |
| SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| SocketLocalAddress | The local network interface to bind the socket to. |
| SocketLocalPort | The local port number to bind the socket to. |
| SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| SocketUseIPv6 | Enables or disables IP protocol version 6. |
| StorageId | Specifies the signing certificate residing in an alternative location. |
| TimestampServer | The address of the timestamping server. |
| TLSServerCertCount | The number of records in the TLSServerCert arrays. |
| TLSServerCertBytes | Returns the raw certificate data in DER format. |
| TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| TLSClientAuth | Enables or disables certificate-based client authentication. |
| TLSExtensions | Provides access to TLS extensions. |
| TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| TLSGroups | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
| TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| TLSMode | Specifies the TLS mode to use. |
| TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
| TLSVersions | The SSL/TLS versions to enable by default. |
| UserCount | The number of records in the User arrays. |
| UserAssociatedData | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
| UserBasePath | Base path for this user in the server's file system. |
| UserData | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
| UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| UserHashAlgorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
| UserIncomingSpeedLimit | Specifies the incoming speed limit for this user. |
| UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
| UserPassword | The user's authentication password. |
| UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
| Username | The registered name (login) of the user. |
| 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.
| Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
| 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. |
| Reset | Resets the class settings. |
| 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 class 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.
| CertPassword | TBD. |
| CertStoragePath | TBD. |
| DataURL | (obsolete) The DataURL parameter to pass to the signer. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| FingerprintAlgorithm | The fingerprint algorithm to use. |
| GoURL | (obsolete) The GoURL parameter to pass to the signer. |
| HandshakeTimeout | The HTTPS handshake timeout. |
| Host | The host to bind to. |
| Is64BitProcess | TBD. |
| KeysEndpoint | TBD. |
| KeyStoragePath | TBD. |
| PolicyHash | The EPES policy hash. |
| PolicyHashAlgorithm | The EPES policy hash algorithm. |
| PolicyID | The EPES policy identifier. |
| PolicyURI | The EPES policy URL. |
| Port | The port to listen on. |
| Port64 | TBD. |
| PortRangeFrom | The lower bound of allowed port scope to listen on. |
| PortRangeTo | The higher bound of allowed port scope to listen on. |
| ReadOnlyMode | TBD. |
| RequireDefinedSignCert | (obsolete) The RequireDefinedSignCert parameter to pass to the signer. |
| SchemeParams | The algorithm scheme parameters to employ. |
| ServerCertificatePassword | TBD. |
| ServerCertificatePath | TBD. |
| SessionID | (obsolete) The SessionID parameter to pass to the signer. |
| SessionTimeout | The HTTP session timeout. |
| SettingsEndpoint | TBD. |
| StatusEndpoint | TBD. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSExtensions | TBD. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TokenName | The TokenName parameter to pass to the signer. |
| TokensLibraries | (obsolete) The TokensLibraries parameter to pass to the signer. |
| TspAttemptCount | Specifies the number of timestamping request attempts. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
| Use64BitService | TBD. |
| WebsiteName | The website name for the TLS certificate. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| 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 class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| 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. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| 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. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
Active Property (DCAuthWebServer Component)
Indicates whether the server is active and is listening to new connections.
Syntax
func (obj *DCAuthWebServer) Active() (bool, error)
Default Value
false
Remarks
This read-only property returns True if the server is listening to incoming connections.
This property is read-only.
Data Type
bool
AllowOrigin Property (DCAuthWebServer Component)
Specifies the content of AllowOrigin header of the service reply.
Syntax
func (obj *DCAuthWebServer) AllowOrigin() (string, error)
func (obj *DCAuthWebServer) SetAllowOrigin(value string) error
Default Value
""
Remarks
Use this property to specify the content of AllowOrigin header included with the service reply. If left empty, the * header will be returned.
Data Type
string
AuthRealm Property (DCAuthWebServer Component)
Specifies authentication realm for digest and NTLM authentication.
Syntax
func (obj *DCAuthWebServer) AuthRealm() (string, error)
func (obj *DCAuthWebServer) SetAuthRealm(value string) error
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
Data Type
string
AuthTypes Property (DCAuthWebServer Component)
Defines allowed HTTP authentication types.
Syntax
func (obj *DCAuthWebServer) AuthTypes() (int32, error)
func (obj *DCAuthWebServer) SetAuthTypes(value int32) error
Default Value
0
Remarks
Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:
| haBasic | 0x01 | Basic authentication |
| haDigest | 0x02 | Digest authentication (RFC 2617) |
| haNTLM | 0x04 | Windows NTLM authentication |
| haKerberos | 0x08 | Kerberos (Negotiate) authentication |
| haOAuth2 | 0x10 | OAuth2 authentication |
Data Type
int32
BoundPort Property (DCAuthWebServer Component)
Indicates the bound listening port.
Syntax
func (obj *DCAuthWebServer) BoundPort() (int32, error)
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.
Data Type
int32
ExternalCryptoAsyncDocumentID Property (DCAuthWebServer Component)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoAsyncDocumentID(value string) error
Default Value
""
Remarks
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
string
ExternalCryptoCustomParams Property (DCAuthWebServer Component)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
func (obj *DCAuthWebServer) ExternalCryptoCustomParams() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoCustomParams(value string) error
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
Data Type
string
ExternalCryptoData Property (DCAuthWebServer Component)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoData() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoData(value string) error
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
Data Type
string
ExternalCryptoExternalHashCalculation Property (DCAuthWebServer Component)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *DCAuthWebServer) SetExternalCryptoExternalHashCalculation(value bool) error
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.
If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
Data Type
bool
ExternalCryptoHashAlgorithm Property (DCAuthWebServer Component)
Specifies the request's signature hash algorithm.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoHashAlgorithm() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoHashAlgorithm(value string) error
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
string
ExternalCryptoKeyID Property (DCAuthWebServer Component)
The ID of the pre-shared key used for DC request authentication.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoKeyID() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoKeyID(value string) error
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
string
ExternalCryptoKeySecret Property (DCAuthWebServer Component)
The pre-shared key used for DC request authentication.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoKeySecret() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoKeySecret(value string) error
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
string
ExternalCryptoMethod Property (DCAuthWebServer Component)
Specifies the asynchronous signing method.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoMethod() (int32, error)
func (obj *DCAuthWebServer) SetExternalCryptoMethod(value int32) error
Possible Values
0 // PKCS1
1 // PKCS7
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
Data Type
int32
ExternalCryptoMode Property (DCAuthWebServer Component)
Specifies the external cryptography mode.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoMode() (int32, error)
func (obj *DCAuthWebServer) SetExternalCryptoMode(value int32) error
Possible Values
0 // Default
1 // Disabled
2 // Generic
3 // DCAuth
4 // DCAuthJSON
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |
Data Type
int32
ExternalCryptoPublicKeyAlgorithm Property (DCAuthWebServer Component)
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
func (obj *DCAuthWebServer) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *DCAuthWebServer) SetExternalCryptoPublicKeyAlgorithm(value string) error
Default Value
""
Remarks
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |
Data Type
string
FIPSMode Property (DCAuthWebServer Component)
Reserved.
Syntax
func (obj *DCAuthWebServer) FIPSMode() (bool, error)
func (obj *DCAuthWebServer) SetFIPSMode(value bool) error
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
HandshakeTimeout Property (DCAuthWebServer Component)
Specifies the handshake timeout in milliseconds.
Syntax
func (obj *DCAuthWebServer) HandshakeTimeout() (int32, error)
func (obj *DCAuthWebServer) SetHandshakeTimeout(value int32) error
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
int32
Host Property (DCAuthWebServer Component)
The host to bind the listening port to.
Syntax
func (obj *DCAuthWebServer) Host() (string, error)
func (obj *DCAuthWebServer) SetHost(value string) error
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections.
Data Type
string
KeyId Property (DCAuthWebServer Component)
Specifies the KeyID of the pre-shared authentication key.
Syntax
func (obj *DCAuthWebServer) KeyId() (string, error)
func (obj *DCAuthWebServer) SetKeyId(value string) error
Default Value
""
Remarks
If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the KeySecret property. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
Data Type
string
KeySecret Property (DCAuthWebServer Component)
The pre-shared authentication key.
Syntax
func (obj *DCAuthWebServer) KeySecret() (string, error)
func (obj *DCAuthWebServer) SetKeySecret(value string) error
Default Value
""
Remarks
If processing requests from a single known party, assign the key you pre-shared with them to this property. Use KeyId property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use KeySecretNeeded event instead.
Data Type
string
PinnedClientAEADCipher Property (DCAuthWebServer Component)
Indicates whether the encryption algorithm used is an AEAD cipher.
Syntax
func (obj *DCAuthWebServer) PinnedClientAEADCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the encryption algorithm used is an AEAD cipher.
This property is read-only.
Data Type
bool
PinnedClientChainValidationDetails Property (DCAuthWebServer Component)
The details of a certificate chain validation outcome.
Syntax
func (obj *DCAuthWebServer) PinnedClientChainValidationDetails() (int32, error)
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only.
Data Type
int32
PinnedClientChainValidationResult Property (DCAuthWebServer Component)
The outcome of a certificate chain validation routine.
Syntax
func (obj *DCAuthWebServer) PinnedClientChainValidationResult() (int32, error)
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only.
Data Type
int32
PinnedClientCiphersuite Property (DCAuthWebServer Component)
The cipher suite employed by this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientCiphersuite() (string, error)
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only.
Data Type
string
PinnedClientClientAuthenticated Property (DCAuthWebServer Component)
Specifies whether client authentication was performed during this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientClientAuthenticated() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only.
Data Type
bool
PinnedClientClientAuthRequested Property (DCAuthWebServer Component)
Specifies whether client authentication was requested during this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientClientAuthRequested() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was requested during this connection.
This property is read-only.
Data Type
bool
PinnedClientConnectionEstablished Property (DCAuthWebServer Component)
Indicates whether the connection has been established fully.
Syntax
func (obj *DCAuthWebServer) PinnedClientConnectionEstablished() (bool, error)
Default Value
false
Remarks
Indicates whether the connection has been established fully.
This property is read-only.
Data Type
bool
PinnedClientConnectionID Property (DCAuthWebServer Component)
The unique identifier assigned to this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientConnectionID() ([]byte, error)
Remarks
The unique identifier assigned to this connection.
This property is read-only.
Data Type
[]byte
PinnedClientDigestAlgorithm Property (DCAuthWebServer Component)
The digest algorithm used in a TLS-enabled connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientDigestAlgorithm() (string, error)
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientEncryptionAlgorithm Property (DCAuthWebServer Component)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientEncryptionAlgorithm() (string, error)
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientExportable Property (DCAuthWebServer Component)
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
Syntax
func (obj *DCAuthWebServer) PinnedClientExportable() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
This property is read-only.
Data Type
bool
PinnedClientGroup Property (DCAuthWebServer Component)
The elliptic curve used in this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientGroup() (string, error)
Default Value
""
Remarks
The elliptic curve used in this connection.
This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.
This property is read-only.
Data Type
string
PinnedClientID Property (DCAuthWebServer Component)
The client connection's unique identifier.
Syntax
func (obj *DCAuthWebServer) PinnedClientID() (int64, error)
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only.
Data Type
int64
PinnedClientKeyExchangeAlgorithm Property (DCAuthWebServer Component)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientKeyExchangeAlgorithm() (string, error)
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientKeyExchangeKeyBits Property (DCAuthWebServer Component)
The length of the key exchange key of a TLS-enabled connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientKeyExchangeKeyBits() (int32, error)
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only.
Data Type
int32
PinnedClientPFSCipher Property (DCAuthWebServer Component)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
func (obj *DCAuthWebServer) PinnedClientPFSCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only.
Data Type
bool
PinnedClientPreSharedIdentity Property (DCAuthWebServer Component)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *DCAuthWebServer) PinnedClientPreSharedIdentity() (string, error)
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only.
Data Type
string
PinnedClientPreSharedIdentityHint Property (DCAuthWebServer Component)
A hint professed by the server to help the client select the PSK identity to use.
Syntax
func (obj *DCAuthWebServer) PinnedClientPreSharedIdentityHint() (string, error)
Default Value
""
Remarks
A hint professed by the server to help the client select the PSK identity to use.
This property is read-only.
Data Type
string
PinnedClientPublicKeyBits Property (DCAuthWebServer Component)
The length of the public key.
Syntax
func (obj *DCAuthWebServer) PinnedClientPublicKeyBits() (int32, error)
Default Value
0
Remarks
The length of the public key.
This property is read-only.
Data Type
int32
PinnedClientRemoteAddress Property (DCAuthWebServer Component)
The client's IP address.
Syntax
func (obj *DCAuthWebServer) PinnedClientRemoteAddress() (string, error)
Default Value
""
Remarks
The client's IP address.
This property is read-only.
Data Type
string
PinnedClientRemotePort Property (DCAuthWebServer Component)
The remote port of the client connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientRemotePort() (int32, error)
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only.
Data Type
int32
PinnedClientResumedSession Property (DCAuthWebServer Component)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientResumedSession() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only.
Data Type
bool
PinnedClientSecureConnection Property (DCAuthWebServer Component)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientSecureConnection() (bool, error)
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only.
Data Type
bool
PinnedClientServerAuthenticated Property (DCAuthWebServer Component)
Indicates whether server authentication was performed during a TLS-enabled connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientServerAuthenticated() (bool, error)
Default Value
false
Remarks
Indicates whether server authentication was performed during a TLS-enabled connection.
This property is read-only.
Data Type
bool
PinnedClientSignatureAlgorithm Property (DCAuthWebServer Component)
The signature algorithm used in a TLS handshake.
Syntax
func (obj *DCAuthWebServer) PinnedClientSignatureAlgorithm() (string, error)
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only.
Data Type
string
PinnedClientSymmetricBlockSize Property (DCAuthWebServer Component)
The block size of the symmetric algorithm used.
Syntax
func (obj *DCAuthWebServer) PinnedClientSymmetricBlockSize() (int32, error)
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientSymmetricKeyBits Property (DCAuthWebServer Component)
The key length of the symmetric algorithm used.
Syntax
func (obj *DCAuthWebServer) PinnedClientSymmetricKeyBits() (int32, error)
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientTotalBytesReceived Property (DCAuthWebServer Component)
The total number of bytes received over this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientTotalBytesReceived() (int64, error)
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only.
Data Type
int64
PinnedClientTotalBytesSent Property (DCAuthWebServer Component)
The total number of bytes sent over this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientTotalBytesSent() (int64, error)
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only.
Data Type
int64
PinnedClientValidationLog Property (DCAuthWebServer Component)
Contains the server certificate's chain validation log.
Syntax
func (obj *DCAuthWebServer) PinnedClientValidationLog() (string, error)
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only.
Data Type
string
PinnedClientVersion Property (DCAuthWebServer Component)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
func (obj *DCAuthWebServer) PinnedClientVersion() (string, error)
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only.
Data Type
string
PinnedClientCertCount Property (DCAuthWebServer Component)
The number of records in the PinnedClientCert arrays.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCAKeyID
- PinnedClientCertFingerprint
- PinnedClientCertHandle
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertPublicKeyBytes
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only.
Data Type
int32
PinnedClientCertBytes Property (DCAuthWebServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertCAKeyID Property (DCAuthWebServer Component)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertCAKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertFingerprint Property (DCAuthWebServer Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertHandle Property (DCAuthWebServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertHandle(PinnedClientCertIndex int32) (int64, error)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int64
PinnedClientCertIssuer Property (DCAuthWebServer Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertIssuer(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertIssuerRDN Property (DCAuthWebServer Component)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertIssuerRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyAlgorithm Property (DCAuthWebServer Component)
Specifies the public key algorithm of this certificate.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertKeyAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |
Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyBits Property (DCAuthWebServer Component)
Returns the length of the public key in bits.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertKeyBits(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertKeyFingerprint Property (DCAuthWebServer Component)
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertKeyFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyUsage Property (DCAuthWebServer Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertKeyUsage(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertPublicKeyBytes Property (DCAuthWebServer Component)
Contains the certificate's public key in DER format.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertPublicKeyBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSelfSigned Property (DCAuthWebServer Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSelfSigned(PinnedClientCertIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
bool
PinnedClientCertSerialNumber Property (DCAuthWebServer Component)
Returns the certificate's serial number.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSerialNumber(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSigAlgorithm Property (DCAuthWebServer Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSigAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubject Property (DCAuthWebServer Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSubject(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubjectKeyID Property (DCAuthWebServer Component)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSubjectKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSubjectRDN Property (DCAuthWebServer Component)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
func (obj *DCAuthWebServer) PinnedClientCertSubjectRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidFrom Property (DCAuthWebServer Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertValidFrom(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidTo Property (DCAuthWebServer Component)
The time point at which the certificate expires, in UTC.
Syntax
func (obj *DCAuthWebServer) PinnedClientCertValidTo(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
Policies Property (DCAuthWebServer Component)
Specifies the policies to use when processing requests.
Syntax
func (obj *DCAuthWebServer) Policies() (int32, error)
func (obj *DCAuthWebServer) SetPolicies(value int32) error
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. |
Data Type
int32
Port Property (DCAuthWebServer Component)
Specifies the port number to listen for connections on.
Syntax
func (obj *DCAuthWebServer) Port() (int32, error)
func (obj *DCAuthWebServer) SetPort(value int32) error
Default Value
80
Remarks
Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.
Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Data Type
int32
PortRangeFrom Property (DCAuthWebServer Component)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
func (obj *DCAuthWebServer) PortRangeFrom() (int32, error)
func (obj *DCAuthWebServer) SetPortRangeFrom(value int32) error
Default Value
0
Remarks
Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
Data Type
int32
PortRangeTo Property (DCAuthWebServer Component)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
func (obj *DCAuthWebServer) PortRangeTo() (int32, error)
func (obj *DCAuthWebServer) SetPortRangeTo(value int32) error
Default Value
0
Remarks
Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.
Data Type
int32
SessionTimeout Property (DCAuthWebServer Component)
Specifies the default session timeout value in milliseconds.
Syntax
func (obj *DCAuthWebServer) SessionTimeout() (int32, error)
func (obj *DCAuthWebServer) SetSessionTimeout(value int32) error
Default Value
360000
Remarks
Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.
Data Type
int32
SignEndpoint Property (DCAuthWebServer Component)
The signing service endpoint.
Syntax
func (obj *DCAuthWebServer) SignEndpoint() (string, error)
func (obj *DCAuthWebServer) SetSignEndpoint(value string) error
Default Value
"/sign"
Remarks
Use this property to specify the signing service end point on the server.
Data Type
string
SigningCertBytes Property (DCAuthWebServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *DCAuthWebServer) SigningCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
SigningCertHandle Property (DCAuthWebServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *DCAuthWebServer) SigningCertHandle() (int64, error)
func (obj *DCAuthWebServer) SetSigningCertHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
SigningChainCount Property (DCAuthWebServer Component)
The number of records in the SigningChain arrays.
Syntax
func (obj *DCAuthWebServer) SigningChainCount() (int32, error)
func (obj *DCAuthWebServer) SetSigningChainCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SigningChainCount - 1.Data Type
int32
SigningChainBytes Property (DCAuthWebServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *DCAuthWebServer) SigningChainBytes(SigningChainIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is read-only.
Data Type
[]byte
SigningChainHandle Property (DCAuthWebServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *DCAuthWebServer) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *DCAuthWebServer) SetSigningChainHandle(SigningChainIndex int32, value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
Data Type
int64
SocketIncomingSpeedLimit Property (DCAuthWebServer Component)
The maximum number of bytes to read from the socket, per second.
Syntax
func (obj *DCAuthWebServer) SocketIncomingSpeedLimit() (int32, error)
func (obj *DCAuthWebServer) SetSocketIncomingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
int32
SocketLocalAddress Property (DCAuthWebServer Component)
The local network interface to bind the socket to.
Syntax
func (obj *DCAuthWebServer) SocketLocalAddress() (string, error)
func (obj *DCAuthWebServer) SetSocketLocalAddress(value string) error
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
string
SocketLocalPort Property (DCAuthWebServer Component)
The local port number to bind the socket to.
Syntax
func (obj *DCAuthWebServer) SocketLocalPort() (int32, error)
func (obj *DCAuthWebServer) SetSocketLocalPort(value int32) error
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
int32
SocketOutgoingSpeedLimit Property (DCAuthWebServer Component)
The maximum number of bytes to write to the socket, per second.
Syntax
func (obj *DCAuthWebServer) SocketOutgoingSpeedLimit() (int32, error)
func (obj *DCAuthWebServer) SetSocketOutgoingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
int32
SocketTimeout Property (DCAuthWebServer Component)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
func (obj *DCAuthWebServer) SocketTimeout() (int32, error)
func (obj *DCAuthWebServer) SetSocketTimeout(value int32) error
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
int32
SocketUseIPv6 Property (DCAuthWebServer Component)
Enables or disables IP protocol version 6.
Syntax
func (obj *DCAuthWebServer) SocketUseIPv6() (bool, error)
func (obj *DCAuthWebServer) SetSocketUseIPv6(value bool) error
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
bool
StorageId Property (DCAuthWebServer Component)
Specifies the signing certificate residing in an alternative location.
Syntax
func (obj *DCAuthWebServer) StorageId() (string, error)
func (obj *DCAuthWebServer) SetStorageId(value string) error
Default Value
""
Remarks
Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.
Example 1: The certificate resides on a PKCS#11 device
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1
Example 2: The certificate resides in a system store
system://localmachine@/?store=MY
You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:
- cn: the common name of the certificate subject.
- keyid: the unique identifier included in subject key identifier extension of the certificate.
- keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
- fingerprint: the fingerprint of the certificate.
Example 3: selecting the certificate with a given fingerprint:
pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344
Data Type
string
TimestampServer Property (DCAuthWebServer Component)
The address of the timestamping server.
Syntax
func (obj *DCAuthWebServer) TimestampServer() (string, error)
func (obj *DCAuthWebServer) SetTimestampServer(value string) error
Default Value
""
Remarks
Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.
SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.
If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:
http://user:password@timestamp.server.com/TsaService
For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.
If this property is left empty, no timestamp will be added to the signature.
Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.
To employ the virtual service, assign an URI of the following format to this property:
virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true
Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:
component.Config("TimestampResponse=308208ab...");
Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.
The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.
The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.
The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.
The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.
All the parameters are optional.
Data Type
string
TLSServerCertCount Property (DCAuthWebServer Component)
The number of records in the TLSServerCert arrays.
Syntax
func (obj *DCAuthWebServer) TLSServerCertCount() (int32, error)
func (obj *DCAuthWebServer) SetTLSServerCertCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.Data Type
int32
TLSServerCertBytes Property (DCAuthWebServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *DCAuthWebServer) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
[]byte
TLSServerCertHandle Property (DCAuthWebServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *DCAuthWebServer) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)
func (obj *DCAuthWebServer) SetTLSServerCertHandle(TLSServerCertIndex int32, value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
Data Type
int64
TLSAutoValidateCertificates Property (DCAuthWebServer Component)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
func (obj *DCAuthWebServer) TLSAutoValidateCertificates() (bool, error)
func (obj *DCAuthWebServer) SetTLSAutoValidateCertificates(value bool) error
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
bool
TLSBaseConfiguration Property (DCAuthWebServer Component)
Selects the base configuration for the TLS settings.
Syntax
func (obj *DCAuthWebServer) TLSBaseConfiguration() (int32, error)
func (obj *DCAuthWebServer) SetTLSBaseConfiguration(value int32) error
Possible Values
0 // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
int32
TLSCiphersuites Property (DCAuthWebServer Component)
A list of ciphersuites separated with commas or semicolons.
Syntax
func (obj *DCAuthWebServer) TLSCiphersuites() (string, error)
func (obj *DCAuthWebServer) SetTLSCiphersuites(value string) error
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
string
TLSClientAuth Property (DCAuthWebServer Component)
Enables or disables certificate-based client authentication.
Syntax
func (obj *DCAuthWebServer) TLSClientAuth() (int32, error)
func (obj *DCAuthWebServer) SetTLSClientAuth(value int32) error
Possible Values
0 // NoAuth
1 // RequestCert
2 // RequireCert
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
Data Type
int32
TLSExtensions Property (DCAuthWebServer Component)
Provides access to TLS extensions.
Syntax
func (obj *DCAuthWebServer) TLSExtensions() (string, error)
func (obj *DCAuthWebServer) SetTLSExtensions(value string) error
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
string
TLSForceResumeIfDestinationChanges Property (DCAuthWebServer Component)
Whether to force TLS session resumption when the destination address changes.
Syntax
func (obj *DCAuthWebServer) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *DCAuthWebServer) SetTLSForceResumeIfDestinationChanges(value bool) error
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
bool
TLSGroups Property (DCAuthWebServer Component)
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Syntax
func (obj *DCAuthWebServer) TLSGroups() (string, error)
func (obj *DCAuthWebServer) SetTLSGroups(value string) error
Default Value
""
Remarks
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:
// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";
// Only enable the hybrid X25519/ML-KEM768 group
client.TLSSettings.Groups = "-all;+x25519mlkem768";
The list of groups supported by the component is provided below. All the names are case-insensitive:
Elliptic curve-based groups:
- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448
Finite field-based groups:
- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192
Post-Quantum and Hybrid groups:
- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024
Note: this property was called ECCurves in SecureBlackbox 2024 and older.
Data Type
string
TLSPreSharedIdentity Property (DCAuthWebServer Component)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *DCAuthWebServer) TLSPreSharedIdentity() (string, error)
func (obj *DCAuthWebServer) SetTLSPreSharedIdentity(value string) error
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Data Type
string
TLSPreSharedKey Property (DCAuthWebServer Component)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
func (obj *DCAuthWebServer) TLSPreSharedKey() (string, error)
func (obj *DCAuthWebServer) SetTLSPreSharedKey(value string) error
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Data Type
string
TLSPreSharedKeyCiphersuite Property (DCAuthWebServer Component)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
func (obj *DCAuthWebServer) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *DCAuthWebServer) SetTLSPreSharedKeyCiphersuite(value string) error
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
string
TLSRenegotiationAttackPreventionMode Property (DCAuthWebServer Component)
Selects the renegotiation attack prevention mechanism.
Syntax
func (obj *DCAuthWebServer) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *DCAuthWebServer) SetTLSRenegotiationAttackPreventionMode(value int32) error
Possible Values
0 // Compatible
1 // Strict
2 // Auto
Default Value
2
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
int32
TLSRevocationCheck Property (DCAuthWebServer Component)
Specifies the kind(s) of revocation check to perform.
Syntax
func (obj *DCAuthWebServer) TLSRevocationCheck() (int32, error)
func (obj *DCAuthWebServer) SetTLSRevocationCheck(value int32) error
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
Data Type
int32
TLSSSLOptions Property (DCAuthWebServer Component)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
func (obj *DCAuthWebServer) TLSSSLOptions() (int32, error)
func (obj *DCAuthWebServer) SetTLSSSLOptions(value int32) error
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
Data Type
int32
TLSMode Property (DCAuthWebServer Component)
Specifies the TLS mode to use.
Syntax
func (obj *DCAuthWebServer) TLSMode() (int32, error)
func (obj *DCAuthWebServer) SetTLSMode(value int32) error
Possible Values
0 // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // MixedTLS
Default Value
0
Remarks
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
Data Type
int32
TLSUseExtendedMasterSecret Property (DCAuthWebServer Component)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
func (obj *DCAuthWebServer) TLSUseExtendedMasterSecret() (bool, error)
func (obj *DCAuthWebServer) SetTLSUseExtendedMasterSecret(value bool) error
Default Value
true
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
bool
TLSUseSessionResumption Property (DCAuthWebServer Component)
Enables or disables the TLS session resumption capability.
Syntax
func (obj *DCAuthWebServer) TLSUseSessionResumption() (bool, error)
func (obj *DCAuthWebServer) SetTLSUseSessionResumption(value bool) error
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
bool
TLSVersions Property (DCAuthWebServer Component)
The SSL/TLS versions to enable by default.
Syntax
func (obj *DCAuthWebServer) TLSVersions() (int32, error)
func (obj *DCAuthWebServer) SetTLSVersions(value int32) error
Default Value
48
Remarks
The SSL/TLS versions to enable by default.
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |
Data Type
int32
UserCount Property (DCAuthWebServer Component)
The number of records in the User arrays.
Syntax
func (obj *DCAuthWebServer) UserCount() (int32, error)
func (obj *DCAuthWebServer) SetUserCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
- UserAssociatedData
- UserBasePath
- UserData
- UserHandle
- UserHashAlgorithm
- UserIncomingSpeedLimit
- Username
- UserOutgoingSpeedLimit
- UserPassword
- UserSharedSecret
Data Type
int32
UserAssociatedData Property (DCAuthWebServer Component)
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
func (obj *DCAuthWebServer) UserAssociatedData(UserIndex int32) ([]byte, error)
func (obj *DCAuthWebServer) SetUserAssociatedData(UserIndex int32, value []byte) error
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
UserBasePath Property (DCAuthWebServer Component)
Base path for this user in the server's file system.
Syntax
func (obj *DCAuthWebServer) UserBasePath(UserIndex int32) (string, error)
func (obj *DCAuthWebServer) SetUserBasePath(UserIndex int32, value string) error
Default Value
""
Remarks
Base path for this user in the server's file system.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserData Property (DCAuthWebServer Component)
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
func (obj *DCAuthWebServer) UserData(UserIndex int32) (string, error)
func (obj *DCAuthWebServer) SetUserData(UserIndex int32, value string) error
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserHandle Property (DCAuthWebServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *DCAuthWebServer) UserHandle(UserIndex int32) (int64, error)
func (obj *DCAuthWebServer) SetUserHandle(UserIndex int32, value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int64
UserHashAlgorithm Property (DCAuthWebServer Component)
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
func (obj *DCAuthWebServer) UserHashAlgorithm(UserIndex int32) (string, error)
func (obj *DCAuthWebServer) SetUserHashAlgorithm(UserIndex int32, value string) error
Default Value
""
Remarks
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserIncomingSpeedLimit Property (DCAuthWebServer Component)
Specifies the incoming speed limit for this user.
Syntax
func (obj *DCAuthWebServer) UserIncomingSpeedLimit(UserIndex int32) (int32, error)
func (obj *DCAuthWebServer) SetUserIncomingSpeedLimit(UserIndex int32, value int32) error
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserOutgoingSpeedLimit Property (DCAuthWebServer Component)
Specifies the outgoing speed limit for this user.
Syntax
func (obj *DCAuthWebServer) UserOutgoingSpeedLimit(UserIndex int32) (int32, error)
func (obj *DCAuthWebServer) SetUserOutgoingSpeedLimit(UserIndex int32, value int32) error
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserPassword Property (DCAuthWebServer Component)
The user's authentication password.
Syntax
func (obj *DCAuthWebServer) UserPassword(UserIndex int32) (string, error)
func (obj *DCAuthWebServer) SetUserPassword(UserIndex int32, value string) error
Default Value
""
Remarks
The user's authentication password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserSharedSecret Property (DCAuthWebServer Component)
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
func (obj *DCAuthWebServer) UserSharedSecret(UserIndex int32) ([]byte, error)
func (obj *DCAuthWebServer) SetUserSharedSecret(UserIndex int32, value []byte) error
Remarks
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
Username Property (DCAuthWebServer Component)
The registered name (login) of the user.
Syntax
func (obj *DCAuthWebServer) Username(UserIndex int32) (string, error)
func (obj *DCAuthWebServer) SetUsername(UserIndex int32, value string) error
Default Value
""
Remarks
The registered name (login) of the user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
WebsiteName Property (DCAuthWebServer Component)
Specifies the web site name to use in the certificate.
Syntax
func (obj *DCAuthWebServer) WebsiteName() (string, error)
func (obj *DCAuthWebServer) SetWebsiteName(value string) error
Default Value
"secureblackbox"
Remarks
If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.
Data Type
string
Cleanup Method (DCAuthWebServer Component)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
func (obj *DCAuthWebServer) Cleanup() error
Remarks
Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.
Config Method (DCAuthWebServer Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *DCAuthWebServer) Config(ConfigurationString string) (string, error)
Remarks
Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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
func (obj *DCAuthWebServer) DoAction(ActionID string, ActionParams string) (string, error)
Remarks
DoAction is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
DropClient Method (DCAuthWebServer Component)
Terminates a client connection.
Syntax
func (obj *DCAuthWebServer) DropClient(ConnectionId int64, Forced bool) error
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
func (obj *DCAuthWebServer) ListClients() (string, error)
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
func (obj *DCAuthWebServer) PinClient(ConnectionId int64) error
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
Reset Method (DCAuthWebServer Component)
Resets the class settings.
Syntax
func (obj *DCAuthWebServer) Reset() error
Remarks
Reset is a generic method available in every struct.
Start Method (DCAuthWebServer Component)
Starts the server.
Syntax
func (obj *DCAuthWebServer) Start() error
Remarks
Use this method to activate the server and start listening to incoming connections.
Stop Method (DCAuthWebServer Component)
Stops the server.
Syntax
func (obj *DCAuthWebServer) Stop() error
Remarks
Call this method to stop listening to incoming connections and deactivate the server.
Accept Event (DCAuthWebServer Component)
Reports an incoming connection.
Syntax
// DCAuthWebServerAcceptEventArgs carries the DCAuthWebServer Accept event's parameters.
type DCAuthWebServerAcceptEventArgs struct {...}
func (args *DCAuthWebServerAcceptEventArgs) RemoteAddress() string
func (args *DCAuthWebServerAcceptEventArgs) RemotePort() int32
func (args *DCAuthWebServerAcceptEventArgs) Accept() bool
func (args *DCAuthWebServerAcceptEventArgs) SetAccept(value bool)
// DCAuthWebServerAcceptEvent defines the signature of the DCAuthWebServer Accept event's handler function.
type DCAuthWebServerAcceptEvent func(sender *DCAuthWebServer, args *DCAuthWebServerAcceptEventArgs)
func (obj *DCAuthWebServer) GetOnAcceptHandler() DCAuthWebServerAcceptEvent
func (obj *DCAuthWebServer) SetOnAcceptHandler(handlerFunc DCAuthWebServerAcceptEvent)
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
// DCAuthWebServerAuthAttemptEventArgs carries the DCAuthWebServer AuthAttempt event's parameters.
type DCAuthWebServerAuthAttemptEventArgs struct {...}
func (args *DCAuthWebServerAuthAttemptEventArgs) ConnectionID() int64
func (args *DCAuthWebServerAuthAttemptEventArgs) HTTPMethod() string
func (args *DCAuthWebServerAuthAttemptEventArgs) URI() string
func (args *DCAuthWebServerAuthAttemptEventArgs) AuthMethod() string
func (args *DCAuthWebServerAuthAttemptEventArgs) Username() string
func (args *DCAuthWebServerAuthAttemptEventArgs) Password() string
func (args *DCAuthWebServerAuthAttemptEventArgs) Allow() bool
func (args *DCAuthWebServerAuthAttemptEventArgs) SetAllow(value bool)
// DCAuthWebServerAuthAttemptEvent defines the signature of the DCAuthWebServer AuthAttempt event's handler function.
type DCAuthWebServerAuthAttemptEvent func(sender *DCAuthWebServer, args *DCAuthWebServerAuthAttemptEventArgs)
func (obj *DCAuthWebServer) GetOnAuthAttemptHandler() DCAuthWebServerAuthAttemptEvent
func (obj *DCAuthWebServer) SetOnAuthAttemptHandler(handlerFunc DCAuthWebServerAuthAttemptEvent)
Remarks
The struct 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.
Note: In case of OAuth 2.0 authentication, Password contains an access token to be validated.
Connect Event (DCAuthWebServer Component)
Reports an accepted connection.
Syntax
// DCAuthWebServerConnectEventArgs carries the DCAuthWebServer Connect event's parameters.
type DCAuthWebServerConnectEventArgs struct {...}
func (args *DCAuthWebServerConnectEventArgs) ConnectionID() int64
func (args *DCAuthWebServerConnectEventArgs) RemoteAddress() string
func (args *DCAuthWebServerConnectEventArgs) RemotePort() int32
// DCAuthWebServerConnectEvent defines the signature of the DCAuthWebServer Connect event's handler function.
type DCAuthWebServerConnectEvent func(sender *DCAuthWebServer, args *DCAuthWebServerConnectEventArgs)
func (obj *DCAuthWebServer) GetOnConnectHandler() DCAuthWebServerConnectEvent
func (obj *DCAuthWebServer) SetOnConnectHandler(handlerFunc DCAuthWebServerConnectEvent)
Remarks
The struct fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as TLSHandshake or Data.
CustomParametersReceived Event (DCAuthWebServer Component)
Passes custom request parameters to the application.
Syntax
// DCAuthWebServerCustomParametersReceivedEventArgs carries the DCAuthWebServer CustomParametersReceived event's parameters.
type DCAuthWebServerCustomParametersReceivedEventArgs struct {...}
func (args *DCAuthWebServerCustomParametersReceivedEventArgs) ConnectionId() int64
func (args *DCAuthWebServerCustomParametersReceivedEventArgs) Value() string
// DCAuthWebServerCustomParametersReceivedEvent defines the signature of the DCAuthWebServer CustomParametersReceived event's handler function.
type DCAuthWebServerCustomParametersReceivedEvent func(sender *DCAuthWebServer, args *DCAuthWebServerCustomParametersReceivedEventArgs)
func (obj *DCAuthWebServer) GetOnCustomParametersReceivedHandler() DCAuthWebServerCustomParametersReceivedEvent
func (obj *DCAuthWebServer) SetOnCustomParametersReceivedHandler(handlerFunc DCAuthWebServerCustomParametersReceivedEvent)
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
// DCAuthWebServerDisconnectEventArgs carries the DCAuthWebServer Disconnect event's parameters.
type DCAuthWebServerDisconnectEventArgs struct {...}
func (args *DCAuthWebServerDisconnectEventArgs) ConnectionID() int64
// DCAuthWebServerDisconnectEvent defines the signature of the DCAuthWebServer Disconnect event's handler function.
type DCAuthWebServerDisconnectEvent func(sender *DCAuthWebServer, args *DCAuthWebServerDisconnectEventArgs)
func (obj *DCAuthWebServer) GetOnDisconnectHandler() DCAuthWebServerDisconnectEvent
func (obj *DCAuthWebServer) SetOnDisconnectHandler(handlerFunc DCAuthWebServerDisconnectEvent)
Remarks
The struct fires this event when a connected client disconnects.
Error Event (DCAuthWebServer Component)
Information about errors during data delivery.
Syntax
// DCAuthWebServerErrorEventArgs carries the DCAuthWebServer Error event's parameters.
type DCAuthWebServerErrorEventArgs struct {...}
func (args *DCAuthWebServerErrorEventArgs) ConnectionID() int64
func (args *DCAuthWebServerErrorEventArgs) ErrorCode() int32
func (args *DCAuthWebServerErrorEventArgs) Fatal() bool
func (args *DCAuthWebServerErrorEventArgs) Remote() bool
func (args *DCAuthWebServerErrorEventArgs) Description() string
// DCAuthWebServerErrorEvent defines the signature of the DCAuthWebServer Error event's handler function.
type DCAuthWebServerErrorEvent func(sender *DCAuthWebServer, args *DCAuthWebServerErrorEventArgs)
func (obj *DCAuthWebServer) GetOnErrorHandler() DCAuthWebServerErrorEvent
func (obj *DCAuthWebServer) SetOnErrorHandler(handlerFunc DCAuthWebServerErrorEvent)
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
// DCAuthWebServerExternalSignEventArgs carries the DCAuthWebServer ExternalSign event's parameters.
type DCAuthWebServerExternalSignEventArgs struct {...}
func (args *DCAuthWebServerExternalSignEventArgs) ConnectionID() int64
func (args *DCAuthWebServerExternalSignEventArgs) OperationId() string
func (args *DCAuthWebServerExternalSignEventArgs) HashAlgorithm() string
func (args *DCAuthWebServerExternalSignEventArgs) Pars() string
func (args *DCAuthWebServerExternalSignEventArgs) Data() string
func (args *DCAuthWebServerExternalSignEventArgs) SignedData() string
func (args *DCAuthWebServerExternalSignEventArgs) SetSignedData(value string)
// DCAuthWebServerExternalSignEvent defines the signature of the DCAuthWebServer ExternalSign event's handler function.
type DCAuthWebServerExternalSignEvent func(sender *DCAuthWebServer, args *DCAuthWebServerExternalSignEventArgs)
func (obj *DCAuthWebServer) GetOnExternalSignHandler() DCAuthWebServerExternalSignEvent
func (obj *DCAuthWebServer) SetOnExternalSignHandler(handlerFunc DCAuthWebServerExternalSignEvent)
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 struct via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
KeySecretNeeded Event (DCAuthWebServer Component)
Requests the key secret from the application.
Syntax
// DCAuthWebServerKeySecretNeededEventArgs carries the DCAuthWebServer KeySecretNeeded event's parameters.
type DCAuthWebServerKeySecretNeededEventArgs struct {...}
func (args *DCAuthWebServerKeySecretNeededEventArgs) ConnectionId() int64
func (args *DCAuthWebServerKeySecretNeededEventArgs) KeyId() string
func (args *DCAuthWebServerKeySecretNeededEventArgs) KeySecret() string
func (args *DCAuthWebServerKeySecretNeededEventArgs) SetKeySecret(value string)
// DCAuthWebServerKeySecretNeededEvent defines the signature of the DCAuthWebServer KeySecretNeeded event's handler function.
type DCAuthWebServerKeySecretNeededEvent func(sender *DCAuthWebServer, args *DCAuthWebServerKeySecretNeededEventArgs)
func (obj *DCAuthWebServer) GetOnKeySecretNeededHandler() DCAuthWebServerKeySecretNeededEvent
func (obj *DCAuthWebServer) SetOnKeySecretNeededHandler(handlerFunc DCAuthWebServerKeySecretNeededEvent)
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
// DCAuthWebServerLogEventArgs carries the DCAuthWebServer Log event's parameters.
type DCAuthWebServerLogEventArgs struct {...}
func (args *DCAuthWebServerLogEventArgs) ConnectionId() int64
func (args *DCAuthWebServerLogEventArgs) LogType() int32
func (args *DCAuthWebServerLogEventArgs) Details() string
// DCAuthWebServerLogEvent defines the signature of the DCAuthWebServer Log event's handler function.
type DCAuthWebServerLogEvent func(sender *DCAuthWebServer, args *DCAuthWebServerLogEventArgs)
func (obj *DCAuthWebServer) GetOnLogHandler() DCAuthWebServerLogEvent
func (obj *DCAuthWebServer) SetOnLogHandler(handlerFunc DCAuthWebServerLogEvent)
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
// DCAuthWebServerNotificationEventArgs carries the DCAuthWebServer Notification event's parameters.
type DCAuthWebServerNotificationEventArgs struct {...}
func (args *DCAuthWebServerNotificationEventArgs) EventID() string
func (args *DCAuthWebServerNotificationEventArgs) EventParam() string
// DCAuthWebServerNotificationEvent defines the signature of the DCAuthWebServer Notification event's handler function.
type DCAuthWebServerNotificationEvent func(sender *DCAuthWebServer, args *DCAuthWebServerNotificationEventArgs)
func (obj *DCAuthWebServer) GetOnNotificationHandler() DCAuthWebServerNotificationEvent
func (obj *DCAuthWebServer) SetOnNotificationHandler(handlerFunc DCAuthWebServerNotificationEvent)
Remarks
The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, 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
// DCAuthWebServerParameterReceivedEventArgs carries the DCAuthWebServer ParameterReceived event's parameters.
type DCAuthWebServerParameterReceivedEventArgs struct {...}
func (args *DCAuthWebServerParameterReceivedEventArgs) ConnectionId() int64
func (args *DCAuthWebServerParameterReceivedEventArgs) Name() string
func (args *DCAuthWebServerParameterReceivedEventArgs) Value() string
// DCAuthWebServerParameterReceivedEvent defines the signature of the DCAuthWebServer ParameterReceived event's handler function.
type DCAuthWebServerParameterReceivedEvent func(sender *DCAuthWebServer, args *DCAuthWebServerParameterReceivedEventArgs)
func (obj *DCAuthWebServer) GetOnParameterReceivedHandler() DCAuthWebServerParameterReceivedEvent
func (obj *DCAuthWebServer) SetOnParameterReceivedHandler(handlerFunc DCAuthWebServerParameterReceivedEvent)
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
// DCAuthWebServerPasswordNeededEventArgs carries the DCAuthWebServer PasswordNeeded event's parameters.
type DCAuthWebServerPasswordNeededEventArgs struct {...}
func (args *DCAuthWebServerPasswordNeededEventArgs) NeededFor() string
func (args *DCAuthWebServerPasswordNeededEventArgs) Id() string
func (args *DCAuthWebServerPasswordNeededEventArgs) Password() string
func (args *DCAuthWebServerPasswordNeededEventArgs) SetPassword(value string)
func (args *DCAuthWebServerPasswordNeededEventArgs) Cancel() bool
func (args *DCAuthWebServerPasswordNeededEventArgs) SetCancel(value bool)
// DCAuthWebServerPasswordNeededEvent defines the signature of the DCAuthWebServer PasswordNeeded event's handler function.
type DCAuthWebServerPasswordNeededEvent func(sender *DCAuthWebServer, args *DCAuthWebServerPasswordNeededEventArgs)
func (obj *DCAuthWebServer) GetOnPasswordNeededHandler() DCAuthWebServerPasswordNeededEvent
func (obj *DCAuthWebServer) SetOnPasswordNeededHandler(handlerFunc DCAuthWebServerPasswordNeededEvent)
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
// DCAuthWebServerReadOptionEventArgs carries the DCAuthWebServer ReadOption event's parameters.
type DCAuthWebServerReadOptionEventArgs struct {...}
func (args *DCAuthWebServerReadOptionEventArgs) ConnectionId() int64
func (args *DCAuthWebServerReadOptionEventArgs) Name() string
func (args *DCAuthWebServerReadOptionEventArgs) Value() string
func (args *DCAuthWebServerReadOptionEventArgs) SetValue(value string)
func (args *DCAuthWebServerReadOptionEventArgs) Success() bool
func (args *DCAuthWebServerReadOptionEventArgs) SetSuccess(value bool)
// DCAuthWebServerReadOptionEvent defines the signature of the DCAuthWebServer ReadOption event's handler function.
type DCAuthWebServerReadOptionEvent func(sender *DCAuthWebServer, args *DCAuthWebServerReadOptionEventArgs)
func (obj *DCAuthWebServer) GetOnReadOptionHandler() DCAuthWebServerReadOptionEvent
func (obj *DCAuthWebServer) SetOnReadOptionHandler(handlerFunc DCAuthWebServerReadOptionEvent)
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
// DCAuthWebServerSelectCertEventArgs carries the DCAuthWebServer SelectCert event's parameters.
type DCAuthWebServerSelectCertEventArgs struct {...}
func (args *DCAuthWebServerSelectCertEventArgs) ConnectionId() int64
func (args *DCAuthWebServerSelectCertEventArgs) CommonName() string
func (args *DCAuthWebServerSelectCertEventArgs) SetCommonName(value string)
func (args *DCAuthWebServerSelectCertEventArgs) KeyID() string
func (args *DCAuthWebServerSelectCertEventArgs) SetKeyID(value string)
func (args *DCAuthWebServerSelectCertEventArgs) KeyUsage() string
func (args *DCAuthWebServerSelectCertEventArgs) SetKeyUsage(value string)
func (args *DCAuthWebServerSelectCertEventArgs) Fingerprint() string
func (args *DCAuthWebServerSelectCertEventArgs) SetFingerprint(value string)
func (args *DCAuthWebServerSelectCertEventArgs) StoreType() string
func (args *DCAuthWebServerSelectCertEventArgs) SetStoreType(value string)
// DCAuthWebServerSelectCertEvent defines the signature of the DCAuthWebServer SelectCert event's handler function.
type DCAuthWebServerSelectCertEvent func(sender *DCAuthWebServer, args *DCAuthWebServerSelectCertEventArgs)
func (obj *DCAuthWebServer) GetOnSelectCertHandler() DCAuthWebServerSelectCertEvent
func (obj *DCAuthWebServer) SetOnSelectCertHandler(handlerFunc DCAuthWebServerSelectCertEvent)
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
// DCAuthWebServerSignRequestEventArgs carries the DCAuthWebServer SignRequest event's parameters.
type DCAuthWebServerSignRequestEventArgs struct {...}
func (args *DCAuthWebServerSignRequestEventArgs) ConnectionId() int64
func (args *DCAuthWebServerSignRequestEventArgs) Method() int32
func (args *DCAuthWebServerSignRequestEventArgs) HashAlgorithm() string
func (args *DCAuthWebServerSignRequestEventArgs) Hash() []byte
func (args *DCAuthWebServerSignRequestEventArgs) KeyID() string
func (args *DCAuthWebServerSignRequestEventArgs) Pars() string
func (args *DCAuthWebServerSignRequestEventArgs) MethodPars() string
func (args *DCAuthWebServerSignRequestEventArgs) Allow() bool
func (args *DCAuthWebServerSignRequestEventArgs) SetAllow(value bool)
// DCAuthWebServerSignRequestEvent defines the signature of the DCAuthWebServer SignRequest event's handler function.
type DCAuthWebServerSignRequestEvent func(sender *DCAuthWebServer, args *DCAuthWebServerSignRequestEventArgs)
func (obj *DCAuthWebServer) GetOnSignRequestHandler() DCAuthWebServerSignRequestEvent
func (obj *DCAuthWebServer) SetOnSignRequestHandler(handlerFunc DCAuthWebServerSignRequestEvent)
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
// DCAuthWebServerSignRequestCompletedEventArgs carries the DCAuthWebServer SignRequestCompleted event's parameters.
type DCAuthWebServerSignRequestCompletedEventArgs struct {...}
func (args *DCAuthWebServerSignRequestCompletedEventArgs) ConnectionId() int64
func (args *DCAuthWebServerSignRequestCompletedEventArgs) Method() int32
func (args *DCAuthWebServerSignRequestCompletedEventArgs) HashAlgorithm() string
func (args *DCAuthWebServerSignRequestCompletedEventArgs) Hash() []byte
func (args *DCAuthWebServerSignRequestCompletedEventArgs) KeyID() string
func (args *DCAuthWebServerSignRequestCompletedEventArgs) Pars() string
func (args *DCAuthWebServerSignRequestCompletedEventArgs) MethodPars() string
func (args *DCAuthWebServerSignRequestCompletedEventArgs) Signature() []byte
// DCAuthWebServerSignRequestCompletedEvent defines the signature of the DCAuthWebServer SignRequestCompleted event's handler function.
type DCAuthWebServerSignRequestCompletedEvent func(sender *DCAuthWebServer, args *DCAuthWebServerSignRequestCompletedEventArgs)
func (obj *DCAuthWebServer) GetOnSignRequestCompletedHandler() DCAuthWebServerSignRequestCompletedEvent
func (obj *DCAuthWebServer) SetOnSignRequestCompletedHandler(handlerFunc DCAuthWebServerSignRequestCompletedEvent)
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 class is ready to request a timestamp from an external TSA.
Syntax
// DCAuthWebServerTimestampRequestEventArgs carries the DCAuthWebServer TimestampRequest event's parameters.
type DCAuthWebServerTimestampRequestEventArgs struct {...}
func (args *DCAuthWebServerTimestampRequestEventArgs) TSA() string
func (args *DCAuthWebServerTimestampRequestEventArgs) TimestampRequest() string
func (args *DCAuthWebServerTimestampRequestEventArgs) TimestampResponse() string
func (args *DCAuthWebServerTimestampRequestEventArgs) SetTimestampResponse(value string)
func (args *DCAuthWebServerTimestampRequestEventArgs) SuppressDefault() bool
func (args *DCAuthWebServerTimestampRequestEventArgs) SetSuppressDefault(value bool)
// DCAuthWebServerTimestampRequestEvent defines the signature of the DCAuthWebServer TimestampRequest event's handler function.
type DCAuthWebServerTimestampRequestEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTimestampRequestEventArgs)
func (obj *DCAuthWebServer) GetOnTimestampRequestHandler() DCAuthWebServerTimestampRequestEvent
func (obj *DCAuthWebServer) SetOnTimestampRequestHandler(handlerFunc DCAuthWebServerTimestampRequestEvent)
Remarks
Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.
The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to true 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
// DCAuthWebServerTLSCertValidateEventArgs carries the DCAuthWebServer TLSCertValidate event's parameters.
type DCAuthWebServerTLSCertValidateEventArgs struct {...}
func (args *DCAuthWebServerTLSCertValidateEventArgs) ConnectionID() int64
func (args *DCAuthWebServerTLSCertValidateEventArgs) Accept() bool
func (args *DCAuthWebServerTLSCertValidateEventArgs) SetAccept(value bool)
// DCAuthWebServerTLSCertValidateEvent defines the signature of the DCAuthWebServer TLSCertValidate event's handler function.
type DCAuthWebServerTLSCertValidateEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTLSCertValidateEventArgs)
func (obj *DCAuthWebServer) GetOnTLSCertValidateHandler() DCAuthWebServerTLSCertValidateEvent
func (obj *DCAuthWebServer) SetOnTLSCertValidateHandler(handlerFunc DCAuthWebServerTLSCertValidateEvent)
Remarks
The struct 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
// DCAuthWebServerTLSEstablishedEventArgs carries the DCAuthWebServer TLSEstablished event's parameters.
type DCAuthWebServerTLSEstablishedEventArgs struct {...}
func (args *DCAuthWebServerTLSEstablishedEventArgs) ConnectionID() int64
// DCAuthWebServerTLSEstablishedEvent defines the signature of the DCAuthWebServer TLSEstablished event's handler function.
type DCAuthWebServerTLSEstablishedEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTLSEstablishedEventArgs)
func (obj *DCAuthWebServer) GetOnTLSEstablishedHandler() DCAuthWebServerTLSEstablishedEvent
func (obj *DCAuthWebServer) SetOnTLSEstablishedHandler(handlerFunc DCAuthWebServerTLSEstablishedEvent)
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
// DCAuthWebServerTLSHandshakeEventArgs carries the DCAuthWebServer TLSHandshake event's parameters.
type DCAuthWebServerTLSHandshakeEventArgs struct {...}
func (args *DCAuthWebServerTLSHandshakeEventArgs) ConnectionID() int64
func (args *DCAuthWebServerTLSHandshakeEventArgs) ServerName() string
func (args *DCAuthWebServerTLSHandshakeEventArgs) Abort() bool
func (args *DCAuthWebServerTLSHandshakeEventArgs) SetAbort(value bool)
// DCAuthWebServerTLSHandshakeEvent defines the signature of the DCAuthWebServer TLSHandshake event's handler function.
type DCAuthWebServerTLSHandshakeEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTLSHandshakeEventArgs)
func (obj *DCAuthWebServer) GetOnTLSHandshakeHandler() DCAuthWebServerTLSHandshakeEvent
func (obj *DCAuthWebServer) SetOnTLSHandshakeHandler(handlerFunc DCAuthWebServerTLSHandshakeEvent)
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
// DCAuthWebServerTLSPSKEventArgs carries the DCAuthWebServer TLSPSK event's parameters.
type DCAuthWebServerTLSPSKEventArgs struct {...}
func (args *DCAuthWebServerTLSPSKEventArgs) ConnectionID() int64
func (args *DCAuthWebServerTLSPSKEventArgs) Identity() string
func (args *DCAuthWebServerTLSPSKEventArgs) PSK() string
func (args *DCAuthWebServerTLSPSKEventArgs) SetPSK(value string)
func (args *DCAuthWebServerTLSPSKEventArgs) Ciphersuite() string
func (args *DCAuthWebServerTLSPSKEventArgs) SetCiphersuite(value string)
// DCAuthWebServerTLSPSKEvent defines the signature of the DCAuthWebServer TLSPSK event's handler function.
type DCAuthWebServerTLSPSKEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTLSPSKEventArgs)
func (obj *DCAuthWebServer) GetOnTLSPSKHandler() DCAuthWebServerTLSPSKEvent
func (obj *DCAuthWebServer) SetOnTLSPSKHandler(handlerFunc DCAuthWebServerTLSPSKEvent)
Remarks
The struct fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (DCAuthWebServer Component)
Reports closure of a TLS session.
Syntax
// DCAuthWebServerTLSShutdownEventArgs carries the DCAuthWebServer TLSShutdown event's parameters.
type DCAuthWebServerTLSShutdownEventArgs struct {...}
func (args *DCAuthWebServerTLSShutdownEventArgs) ConnectionID() int64
// DCAuthWebServerTLSShutdownEvent defines the signature of the DCAuthWebServer TLSShutdown event's handler function.
type DCAuthWebServerTLSShutdownEvent func(sender *DCAuthWebServer, args *DCAuthWebServerTLSShutdownEventArgs)
func (obj *DCAuthWebServer) GetOnTLSShutdownHandler() DCAuthWebServerTLSShutdownEvent
func (obj *DCAuthWebServer) SetOnTLSShutdownHandler(handlerFunc DCAuthWebServerTLSShutdownEvent)
Remarks
The struct 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
// DCAuthWebServerWriteOptionEventArgs carries the DCAuthWebServer WriteOption event's parameters.
type DCAuthWebServerWriteOptionEventArgs struct {...}
func (args *DCAuthWebServerWriteOptionEventArgs) ConnectionId() int64
func (args *DCAuthWebServerWriteOptionEventArgs) Name() string
func (args *DCAuthWebServerWriteOptionEventArgs) Value() string
// DCAuthWebServerWriteOptionEvent defines the signature of the DCAuthWebServer WriteOption event's handler function.
type DCAuthWebServerWriteOptionEvent func(sender *DCAuthWebServer, args *DCAuthWebServerWriteOptionEventArgs)
func (obj *DCAuthWebServer) GetOnWriteOptionHandler() DCAuthWebServerWriteOptionEvent
func (obj *DCAuthWebServer) SetOnWriteOptionHandler(handlerFunc DCAuthWebServerWriteOptionEvent)
Remarks
Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.
Config Settings (DCAuthWebServer Component)
The struct 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 struct, access to these internal properties is provided through the Config method.DCAuthWebServer Config Settings
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
Note: Unlike other structs, PDFSigner struct uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported Values:
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");