DCAuthWebServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_DCAuthWebServer

Procedural Interface

 secureblackbox_dcauthwebserver_open();
 secureblackbox_dcauthwebserver_close($res);
 secureblackbox_dcauthwebserver_register_callback($res, $id, $function);
 secureblackbox_dcauthwebserver_get_last_error($res);
 secureblackbox_dcauthwebserver_get_last_error_code($res);
 secureblackbox_dcauthwebserver_set($res, $id, $index, $value);
 secureblackbox_dcauthwebserver_get($res, $id, $index);
 secureblackbox_dcauthwebserver_do_config($res, $configurationstring);
 secureblackbox_dcauthwebserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_dcauthwebserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_dcauthwebserver_do_listclients($res);
 secureblackbox_dcauthwebserver_do_pinclient($res, $connectionid);
 secureblackbox_dcauthwebserver_do_start($res);
 secureblackbox_dcauthwebserver_do_stop($res);

Remarks

DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific Port or a port chosen between PortRangeFrom and PortRangeTo. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.

Property List


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

ActiveIndicates whether the server is active and is listening to new connections.
AllowOriginSpecifies the content of AllowOrigin header of the service reply.
AuthBasicEnables or disables basic authentication.
AuthDigestEnables or disables digest authentication.
AuthDigestExpireSpecifies digest expiration time for digest authentication.
AuthRealmSpecifies authentication realm for digest and NTLM authentication.
BoundPortIndicates the bound listening port.
ClientAuthEnables or disables certificate-based client authentication.
ErrorOriginIndicates the endpoint where the error originates from.
ErrorSeverityThe severity of the error that happened.
ExternalCryptoAsyncDocumentIDSpecifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
ExternalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
ExternalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecretThe pre-shared key used for DC request authentication.
ExternalCryptoMethodSpecifies the asynchronous signing method.
ExternalCryptoModeSpecifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithmProvide the public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSModeReserved.
HandshakeTimeoutSpecifies the handshake timeout in milliseconds.
HostThe host to bind the listening port to.
KeyIdSpecifies the KeyID of the pre-shared authentication key.
KeySecretThe pre-shared authentication key.
PinnedClientAddressThe client's IP address.
PinnedClientChainValidationDetailsThe details of a certificate chain validation outcome.
PinnedClientChainValidationResultThe outcome of a certificate chain validation routine.
PinnedClientCiphersuiteThe cipher suite employed by this connection.
PinnedClientClientAuthenticatedSpecifies whether client authentication was performed during this connection.
PinnedClientDigestAlgorithmThe digest algorithm used in a TLS-enabled connection.
PinnedClientEncryptionAlgorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
PinnedClientIDThe client connection's unique identifier.
PinnedClientKeyExchangeAlgorithmThe key exchange algorithm used in a TLS-enabled connection.
PinnedClientKeyExchangeKeyBitsThe length of the key exchange key of a TLS-enabled connection.
PinnedClientNamedECCurveThe elliptic curve used in this connection.
PinnedClientPFSCipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PinnedClientPortThe remote port of the client connection.
PinnedClientPreSharedIdentitySpecifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PinnedClientPublicKeyBitsThe length of the public key.
PinnedClientResumedSessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
PinnedClientSecureConnectionIndicates whether TLS or SSL is enabled for this connection.
PinnedClientSignatureAlgorithmThe signature algorithm used in a TLS handshake.
PinnedClientSymmetricBlockSizeThe block size of the symmetric algorithm used.
PinnedClientSymmetricKeyBitsThe key length of the symmetric algorithm used.
PinnedClientTotalBytesReceivedThe total number of bytes received over this connection.
PinnedClientTotalBytesSentThe total number of bytes sent over this connection.
PinnedClientValidationLogContains the server certificate's chain validation log.
PinnedClientVersionIndicates the version of SSL/TLS protocol negotiated during this connection.
PinnedClientCertCountThe number of records in the PinnedClientCert arrays.
PinnedClientCertBytesReturns the raw certificate data in DER format.
PinnedClientCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
PinnedClientCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
PinnedClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
PinnedClientCertIssuerThe common name of the certificate issuer (CA), typically a company name.
PinnedClientCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
PinnedClientCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
PinnedClientCertKeyBitsReturns the length of the public key.
PinnedClientCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
PinnedClientCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
PinnedClientCertPublicKeyBytesContains the certificate's public key in DER format.
PinnedClientCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
PinnedClientCertSerialNumberReturns the certificate's serial number.
PinnedClientCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
PinnedClientCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
PinnedClientCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
PinnedClientCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
PinnedClientCertValidFromThe time point at which the certificate becomes valid, in UTC.
PinnedClientCertValidToThe time point at which the certificate expires, in UTC.
PoliciesSpecifies the policies to use when processing requests.
PortSpecifies the port number to listen for connections on.
PortRangeFromSpecifies the lower limit of the listening port range for incoming connections.
PortRangeToSpecifies the upper limit of the listening port range for incoming connections.
ServerCertCountThe number of records in the ServerCert arrays.
ServerCertBytesReturns the raw certificate data in DER format.
ServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SessionTimeoutSpecifies the default session timeout value in milliseconds.
SignEndpointThe signing service endpoint.
SigningCertBytesReturns the raw certificate data in DER format.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningChainCountThe number of records in the SigningChain arrays.
SigningChainBytesReturns the raw certificate data in DER format.
SigningChainHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
StorageIdSpecifies the signing certificate residing in an alternative location.
TimestampServerThe address of the timestamping server.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSECCurvesDefines the elliptic curves to enable.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects the renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious 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.
TLSTLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables the TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
UserCountThe number of records in the User arrays.
UserAssociatedDataContains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
UserBasePathBase path for this user in the server's file system.
UserCertContains the user's certificate.
UserDataContains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
UserHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UserHashAlgorithmSpecifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
UserIncomingSpeedLimitSpecifies the incoming speed limit for this user.
UserOutgoingSpeedLimitSpecifies the outgoing speed limit for this user.
UserPasswordThe user's authentication password.
UserSharedSecretContains the user's secret key, which is essentially a shared secret between the client and server.
UserUsernameThe registered name (login) of the user.
WebsiteNameSpecifies the web site name to use in the certificate.

Method List


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

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
DropClientTerminates a client connection.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
StartStarts the server.
StopStops the server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

AcceptReports an incoming connection.
AuthAttemptFires when a connected client makes an authentication attempt.
ConnectReports an accepted connection.
CustomParametersReceivedPasses custom request parameters to the application.
DisconnectFires to report a disconnected client.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
KeySecretNeededRequests the key secret from the application.
LogReports a single log line.
NotificationThis event notifies the application about an underlying control flow event.
ParameterReceivedPasses a standard request parameter to the user code.
PasswordNeededRequests a password from the application.
ReadOptionFires when the client sends in a read option request.
SelectCertRequests certificate selection criteria from the application.
SignRequestThis event signifies the processing of an atomic signing request.
SignRequestCompletedThis event signifies completion of the processing of an atomic signing request.
TimestampRequestFires when the class is ready to request a timestamp from an external TSA.
TLSCertValidateFires when a client certificate needs to be validated.
TLSEstablishedReports the setup of a TLS session.
TLSHandshakeFires when a newly established client connection initiates a TLS handshake.
TLSPSKRequests a pre-shared key for TLS-PSK.
TLSShutdownReports closure of a TLS session.
WriteOptionFires when the client sends in a write option request.

Config Settings


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

CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Active Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getActive();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 1 );


Default Value

false

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

Data Type

Boolean

AllowOrigin Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the content of AllowOrigin header of the service reply.

Object Oriented Interface


public function getAllowOrigin();


public function setAllowOrigin($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 2 );


secureblackbox_dcauthwebserver_set($res, 2, $value );

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

AuthBasic Property (SecureBlackbox_DCAuthWebServer Class)

Enables or disables basic authentication.

Object Oriented Interface


public function getAuthBasic();


public function setAuthBasic($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 3 );


secureblackbox_dcauthwebserver_set($res, 3, $value );

Default Value

false

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

Data Type

Boolean

AuthDigest Property (SecureBlackbox_DCAuthWebServer Class)

Enables or disables digest authentication.

Object Oriented Interface


public function getAuthDigest();


public function setAuthDigest($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 4 );


secureblackbox_dcauthwebserver_set($res, 4, $value );

Default Value

false

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

Data Type

Boolean

AuthDigestExpire Property (SecureBlackbox_DCAuthWebServer Class)

Specifies digest expiration time for digest authentication.

Object Oriented Interface


public function getAuthDigestExpire();


public function setAuthDigestExpire($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 5 );


secureblackbox_dcauthwebserver_set($res, 5, $value );

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds. This is effectively the maximal time between the first and the second steps of the authentication process.

Data Type

Integer

AuthRealm Property (SecureBlackbox_DCAuthWebServer Class)

Specifies authentication realm for digest and NTLM authentication.

Object Oriented Interface


public function getAuthRealm();


public function setAuthRealm($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 6 );


secureblackbox_dcauthwebserver_set($res, 6, $value );

Default Value

'SecureBlackbox'

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

BoundPort Property (SecureBlackbox_DCAuthWebServer Class)

Indicates the bound listening port.

Object Oriented Interface


public function getBoundPort();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 7 );


Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

Data Type

Integer

ClientAuth Property (SecureBlackbox_DCAuthWebServer Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface


public function getClientAuth();


public function setClientAuth($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 8 );


secureblackbox_dcauthwebserver_set($res, 8, $value );

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

Data Type

Integer

ErrorOrigin Property (SecureBlackbox_DCAuthWebServer Class)

Indicates the endpoint where the error originates from.

Object Oriented Interface


public function getErrorOrigin();


public function setErrorOrigin($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 9 );


secureblackbox_dcauthwebserver_set($res, 9, $value );

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

eoLocal0
eoRemote1

This property is not available at design time.

Data Type

Integer

ErrorSeverity Property (SecureBlackbox_DCAuthWebServer Class)

The severity of the error that happened.

Object Oriented Interface


public function getErrorSeverity();


public function setErrorSeverity($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 10 );


secureblackbox_dcauthwebserver_set($res, 10, $value );

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

esWarning1
esFatal2

This property is not available at design time.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 11 );


secureblackbox_dcauthwebserver_set($res, 11, $value );

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

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

Object Oriented Interface


public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 12 );


secureblackbox_dcauthwebserver_set($res, 12, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 13 );


secureblackbox_dcauthwebserver_set($res, 13, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 14 );


secureblackbox_dcauthwebserver_set($res, 14, $value );

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface


public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 15 );


secureblackbox_dcauthwebserver_set($res, 15, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 16 );


secureblackbox_dcauthwebserver_set($res, 16, $value );

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

The pre-shared key used for DC request authentication.

Object Oriented Interface


public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 17 );


secureblackbox_dcauthwebserver_set($res, 17, $value );

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

Specifies the asynchronous signing method.

Object Oriented Interface


public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 18 );


secureblackbox_dcauthwebserver_set($res, 18, $value );

Default Value

0

Remarks

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

Available options:

asmdPKCS10
asmdPKCS71

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the external cryptography mode.

Object Oriented Interface


public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 19 );


secureblackbox_dcauthwebserver_set($res, 19, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 20 );


secureblackbox_dcauthwebserver_set($res, 20, $value );

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_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Data Type

String

FIPSMode Property (SecureBlackbox_DCAuthWebServer Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 21 );


secureblackbox_dcauthwebserver_set($res, 21, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the handshake timeout in milliseconds.

Object Oriented Interface


public function getHandshakeTimeout();


public function setHandshakeTimeout($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 22 );


secureblackbox_dcauthwebserver_set($res, 22, $value );

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (SecureBlackbox_DCAuthWebServer Class)

The host to bind the listening port to.

Object Oriented Interface


public function getHost();


public function setHost($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 23 );


secureblackbox_dcauthwebserver_set($res, 23, $value );

Default Value

''

Remarks

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

Data Type

String

KeyId Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the KeyID of the pre-shared authentication key.

Object Oriented Interface


public function getKeyId();


public function setKeyId($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 24 );


secureblackbox_dcauthwebserver_set($res, 24, $value );

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

The pre-shared authentication key.

Object Oriented Interface


public function getKeySecret();


public function setKeySecret($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 25 );


secureblackbox_dcauthwebserver_set($res, 25, $value );

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

PinnedClientAddress Property (SecureBlackbox_DCAuthWebServer Class)

The client's IP address.

Object Oriented Interface


public function getPinnedClientAddress();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 26 );


Default Value

''

Remarks

The client's IP address.

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

Data Type

String

PinnedClientChainValidationDetails Property (SecureBlackbox_DCAuthWebServer Class)

The details of a certificate chain validation outcome.

Object Oriented Interface


public function getPinnedClientChainValidationDetails();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 27 );


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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

PinnedClientChainValidationResult Property (SecureBlackbox_DCAuthWebServer Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface


public function getPinnedClientChainValidationResult();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 28 );


Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The 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 and not available at design time.

Data Type

Integer

PinnedClientCiphersuite Property (SecureBlackbox_DCAuthWebServer Class)

The cipher suite employed by this connection.

Object Oriented Interface


public function getPinnedClientCiphersuite();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 29 );


Default Value

''

Remarks

The cipher suite employed by this connection.

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

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

Data Type

String

PinnedClientClientAuthenticated Property (SecureBlackbox_DCAuthWebServer Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface


public function getPinnedClientClientAuthenticated();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 30 );


Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

PinnedClientDigestAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface


public function getPinnedClientDigestAlgorithm();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 31 );


Default Value

''

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientEncryptionAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientEncryptionAlgorithm();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 32 );


Default Value

''

Remarks

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

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

Data Type

String

PinnedClientID Property (SecureBlackbox_DCAuthWebServer Class)

The client connection's unique identifier.

Object Oriented Interface


public function getPinnedClientID();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 33 );


Default Value

-1

Remarks

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

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

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientKeyExchangeAlgorithm();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 34 );


Default Value

''

Remarks

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

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

Data Type

String

PinnedClientKeyExchangeKeyBits Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientKeyExchangeKeyBits();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 35 );


Default Value

0

Remarks

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

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

Data Type

Integer

PinnedClientNamedECCurve Property (SecureBlackbox_DCAuthWebServer Class)

The elliptic curve used in this connection.

Object Oriented Interface


public function getPinnedClientNamedECCurve();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 36 );


Default Value

''

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientPFSCipher();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 37 );


Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientPort Property (SecureBlackbox_DCAuthWebServer Class)

The remote port of the client connection.

Object Oriented Interface


public function getPinnedClientPort();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 38 );


Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientPreSharedIdentity Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientPreSharedIdentity();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 39 );


Default Value

''

Remarks

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

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

Data Type

String

PinnedClientPublicKeyBits Property (SecureBlackbox_DCAuthWebServer Class)

The length of the public key.

Object Oriented Interface


public function getPinnedClientPublicKeyBits();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 40 );


Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientResumedSession Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientResumedSession();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 41 );


Default Value

false

Remarks

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

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

Data Type

Boolean

PinnedClientSecureConnection Property (SecureBlackbox_DCAuthWebServer Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface


public function getPinnedClientSecureConnection();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 42 );


Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface


public function getPinnedClientSignatureAlgorithm();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 43 );


Default Value

''

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

PinnedClientSymmetricBlockSize Property (SecureBlackbox_DCAuthWebServer Class)

The block size of the symmetric algorithm used.

Object Oriented Interface


public function getPinnedClientSymmetricBlockSize();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 44 );


Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientSymmetricKeyBits Property (SecureBlackbox_DCAuthWebServer Class)

The key length of the symmetric algorithm used.

Object Oriented Interface


public function getPinnedClientSymmetricKeyBits();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 45 );


Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientTotalBytesReceived Property (SecureBlackbox_DCAuthWebServer Class)

The total number of bytes received over this connection.

Object Oriented Interface


public function getPinnedClientTotalBytesReceived();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 46 );


Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

PinnedClientTotalBytesSent Property (SecureBlackbox_DCAuthWebServer Class)

The total number of bytes sent over this connection.

Object Oriented Interface


public function getPinnedClientTotalBytesSent();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 47 );


Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientValidationLog Property (SecureBlackbox_DCAuthWebServer Class)

Contains the server certificate's chain validation log.

Object Oriented Interface


public function getPinnedClientValidationLog();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 48 );


Default Value

''

Remarks

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

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

Data Type

String

PinnedClientVersion Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientVersion();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 49 );


Default Value

''

Remarks

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

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

Data Type

String

PinnedClientCertCount Property (SecureBlackbox_DCAuthWebServer Class)

The number of records in the PinnedClientCert arrays.

Object Oriented Interface


public function getPinnedClientCertCount();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 50 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

PinnedClientCertBytes Property (SecureBlackbox_DCAuthWebServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getPinnedClientCertBytes($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 51 , $pinnedclientcertindex);


Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

PinnedClientCertCAKeyID Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertCAKeyID($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 53 , $pinnedclientcertindex);


Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

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

Data Type

Byte Array

PinnedClientCertFingerprint Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertFingerprint($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 56 , $pinnedclientcertindex);


Remarks

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

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

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

Data Type

Byte Array

PinnedClientCertHandle Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertHandle($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 58 , $pinnedclientcertindex);


Default Value

0

Remarks

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

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

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

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

Data Type

Long64

PinnedClientCertIssuer Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertIssuer($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 60 , $pinnedclientcertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertIssuerRDN Property (SecureBlackbox_DCAuthWebServer Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface


public function getPinnedClientCertIssuerRDN($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 61 , $pinnedclientcertindex);


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 62 , $pinnedclientcertindex);


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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

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

Data Type

String

PinnedClientCertKeyBits Property (SecureBlackbox_DCAuthWebServer Class)

Returns the length of the public key.

Object Oriented Interface


public function getPinnedClientCertKeyBits($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 63 , $pinnedclientcertindex);


Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

PinnedClientCertKeyFingerprint Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 64 , $pinnedclientcertindex);


Remarks

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

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

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

Data Type

Byte Array

PinnedClientCertKeyUsage Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertKeyUsage($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 65 , $pinnedclientcertindex);


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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

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

Data Type

Integer

PinnedClientCertPublicKeyBytes Property (SecureBlackbox_DCAuthWebServer Class)

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 74 , $pinnedclientcertindex);


Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

PinnedClientCertSelfSigned Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertSelfSigned($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 76 , $pinnedclientcertindex);


Default Value

false

Remarks

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

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

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

Data Type

Boolean

PinnedClientCertSerialNumber Property (SecureBlackbox_DCAuthWebServer Class)

Returns the certificate's serial number.

Object Oriented Interface


public function getPinnedClientCertSerialNumber($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 77 , $pinnedclientcertindex);


Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 78 , $pinnedclientcertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertSubject Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertSubject($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 79 , $pinnedclientcertindex);


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.

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

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

Data Type

String

PinnedClientCertSubjectKeyID Property (SecureBlackbox_DCAuthWebServer Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface


public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 81 , $pinnedclientcertindex);


Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (SecureBlackbox_DCAuthWebServer Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface


public function getPinnedClientCertSubjectRDN($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 82 , $pinnedclientcertindex);


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

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

Data Type

String

PinnedClientCertValidFrom Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertValidFrom($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 83 , $pinnedclientcertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

PinnedClientCertValidTo Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPinnedClientCertValidTo($pinnedclientcertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 84 , $pinnedclientcertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

Policies Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the policies to use when processing requests.

Object Oriented Interface


public function getPolicies();


public function setPolicies($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 85 );


secureblackbox_dcauthwebserver_set($res, 85, $value );

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:

aspAcceptUnsignedRequests1Allows the component to accept unauthenticated messages (those not signed with KeyID/KeySecret). Use with extreme care.

aspIgnorePKCS1Requests2Ignore requests of PKCS1 type.

aspIgnorePKCS7Requests4Ignore requests of PKCS7 type.

aspIgnoreRequestTSA8Ignore the TSA URL provided in the request, and either stick with the service provided via TimestampServer property, or not timestamp the message altogether.

aspIgnoreRequestSigningTime16Ignore the signing time included in the request.

aspIgnoreRequestPKCS7Settings32Ignore auxiliary PKCS7 settings (content type, attributes) included in the request.

aspAlwaysTimestampSigs64Timestamp created signatures (PKCS7 only), even if the client did not request it.

This property is not available at design time.

Data Type

Integer

Port Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the port number to listen for connections on.

Object Oriented Interface


public function getPort();


public function setPort($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 86 );


secureblackbox_dcauthwebserver_set($res, 86, $value );

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Data Type

Integer

PortRangeFrom Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPortRangeFrom();


public function setPortRangeFrom($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 87 );


secureblackbox_dcauthwebserver_set($res, 87, $value );

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

PortRangeTo Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getPortRangeTo();


public function setPortRangeTo($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 88 );


secureblackbox_dcauthwebserver_set($res, 88, $value );

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

ServerCertCount Property (SecureBlackbox_DCAuthWebServer Class)

The number of records in the ServerCert arrays.

Object Oriented Interface


public function getServerCertCount();


public function setServerCertCount($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 89 );


secureblackbox_dcauthwebserver_set($res, 89, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_DCAuthWebServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getServerCertBytes($servercertindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 90 , $servercertindex);


Remarks

Returns the raw certificate data in DER format.

The $servercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getServerCertHandle($servercertindex);


public function setServerCertHandle($servercertindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 97 , $servercertindex);


secureblackbox_dcauthwebserver_set($res, 97, $value , $servercertindex);

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 $servercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is not available at design time.

Data Type

Long64

SessionTimeout Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the default session timeout value in milliseconds.

Object Oriented Interface


public function getSessionTimeout();


public function setSessionTimeout($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 124 );


secureblackbox_dcauthwebserver_set($res, 124, $value );

Default Value

360000

Remarks

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

Data Type

Integer

SignEndpoint Property (SecureBlackbox_DCAuthWebServer Class)

The signing service endpoint.

Object Oriented Interface


public function getSignEndpoint();


public function setSignEndpoint($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 125 );


secureblackbox_dcauthwebserver_set($res, 125, $value );

Default Value

'/sign'

Remarks

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

Data Type

String

SigningCertBytes Property (SecureBlackbox_DCAuthWebServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getSigningCertBytes();


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 126 );


Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getSigningCertHandle();


public function setSigningCertHandle($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 133 );


secureblackbox_dcauthwebserver_set($res, 133, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_DCAuthWebServer Class)

The number of records in the SigningChain arrays.

Object Oriented Interface


public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 160 );


secureblackbox_dcauthwebserver_set($res, 160, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_DCAuthWebServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getSigningChainBytes($signingchainindex);


Procedural Interface


secureblackbox_dcauthwebserver_get($res, 161 , $signingchainindex);


Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 168 , $signingchainindex);


secureblackbox_dcauthwebserver_set($res, 168, $value , $signingchainindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 200 );


secureblackbox_dcauthwebserver_set($res, 200, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_DCAuthWebServer Class)

The local network interface to bind the socket to.

Object Oriented Interface


public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 201 );


secureblackbox_dcauthwebserver_set($res, 201, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_DCAuthWebServer Class)

The local port number to bind the socket to.

Object Oriented Interface


public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 202 );


secureblackbox_dcauthwebserver_set($res, 202, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 203 );


secureblackbox_dcauthwebserver_set($res, 203, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 204 );


secureblackbox_dcauthwebserver_set($res, 204, $value );

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (SecureBlackbox_DCAuthWebServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface


public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 205 );


secureblackbox_dcauthwebserver_set($res, 205, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StorageId Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the signing certificate residing in an alternative location.

Object Oriented Interface


public function getStorageId();


public function setStorageId($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 206 );


secureblackbox_dcauthwebserver_set($res, 206, $value );

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

The address of the timestamping server.

Object Oriented Interface


public function getTimestampServer();


public function setTimestampServer($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 207 );


secureblackbox_dcauthwebserver_set($res, 207, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

All the parameters are optional.

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 208 );


secureblackbox_dcauthwebserver_set($res, 208, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_DCAuthWebServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface


public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 209 );


secureblackbox_dcauthwebserver_set($res, 209, $value );

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.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_DCAuthWebServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface


public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 210 );


secureblackbox_dcauthwebserver_set($res, 210, $value );

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

TLSECCurves Property (SecureBlackbox_DCAuthWebServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface


public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 211 );


secureblackbox_dcauthwebserver_set($res, 211, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_DCAuthWebServer Class)

Provides access to TLS extensions.

Object Oriented Interface


public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 212 );


secureblackbox_dcauthwebserver_set($res, 212, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 213 );


secureblackbox_dcauthwebserver_set($res, 213, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 214 );


secureblackbox_dcauthwebserver_set($res, 214, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 215 );


secureblackbox_dcauthwebserver_set($res, 215, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 216 );


secureblackbox_dcauthwebserver_set($res, 216, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_DCAuthWebServer Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface


public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 217 );


secureblackbox_dcauthwebserver_set($res, 217, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 218 );


secureblackbox_dcauthwebserver_set($res, 218, $value );

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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All 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.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_DCAuthWebServer Class)

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.

Object Oriented Interface


public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 219 );


secureblackbox_dcauthwebserver_set($res, 219, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the TLS mode to use.

Object Oriented Interface


public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 220 );


secureblackbox_dcauthwebserver_set($res, 220, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 221 );


secureblackbox_dcauthwebserver_set($res, 221, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_DCAuthWebServer Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface


public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 222 );


secureblackbox_dcauthwebserver_set($res, 222, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_DCAuthWebServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface


public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 223 );


secureblackbox_dcauthwebserver_set($res, 223, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Data Type

Integer

UserCount Property (SecureBlackbox_DCAuthWebServer Class)

The number of records in the User arrays.

Object Oriented Interface


public function getUserCount();


public function setUserCount($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 224 );


secureblackbox_dcauthwebserver_set($res, 224, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserAssociatedData($userindex);


public function setUserAssociatedData($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 225 , $userindex);


secureblackbox_dcauthwebserver_set($res, 225, $value , $userindex);

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserBasePath($userindex);


public function setUserBasePath($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 226 , $userindex);


secureblackbox_dcauthwebserver_set($res, 226, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserCert Property (SecureBlackbox_DCAuthWebServer Class)

Contains the user's certificate.

Object Oriented Interface


public function getUserCert($userindex);


public function setUserCert($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 227 , $userindex);


secureblackbox_dcauthwebserver_set($res, 227, $value , $userindex);

Remarks

Contains the user's certificate.

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

This property is not available at design time.

Data Type

Byte Array

UserData Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserData($userindex);


public function setUserData($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 228 , $userindex);


secureblackbox_dcauthwebserver_set($res, 228, $value , $userindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UserHandle Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserHandle($userindex);


public function setUserHandle($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 229 , $userindex);


secureblackbox_dcauthwebserver_set($res, 229, $value , $userindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserHashAlgorithm($userindex);


public function setUserHashAlgorithm($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 230 , $userindex);


secureblackbox_dcauthwebserver_set($res, 230, $value , $userindex);

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_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface


public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 231 , $userindex);


secureblackbox_dcauthwebserver_set($res, 231, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface


public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 234 , $userindex);


secureblackbox_dcauthwebserver_set($res, 234, $value , $userindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (SecureBlackbox_DCAuthWebServer Class)

The user's authentication password.

Object Oriented Interface


public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 235 , $userindex);


secureblackbox_dcauthwebserver_set($res, 235, $value , $userindex);

Default Value

''

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserSharedSecret Property (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface


public function getUserSharedSecret($userindex);


public function setUserSharedSecret($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 237 , $userindex);


secureblackbox_dcauthwebserver_set($res, 237, $value , $userindex);

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (SecureBlackbox_DCAuthWebServer Class)

The registered name (login) of the user.

Object Oriented Interface


public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 239 , $userindex);


secureblackbox_dcauthwebserver_set($res, 239, $value , $userindex);

Default Value

''

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

WebsiteName Property (SecureBlackbox_DCAuthWebServer Class)

Specifies the web site name to use in the certificate.

Object Oriented Interface


public function getWebsiteName();


public function setWebsiteName($value);

Procedural Interface


secureblackbox_dcauthwebserver_get($res, 240 );


secureblackbox_dcauthwebserver_set($res, 240, $value );

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

Config Method (SecureBlackbox_DCAuthWebServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_dcauthwebserver_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SecureBlackbox_DCAuthWebServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_dcauthwebserver_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DropClient Method (SecureBlackbox_DCAuthWebServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

secureblackbox_dcauthwebserver_do_dropclient($res, $connectionid, $forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

ListClients Method (SecureBlackbox_DCAuthWebServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_dcauthwebserver_do_listclients($res);

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

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

secureblackbox_dcauthwebserver_do_pinclient($res, $connectionid);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

Start Method (SecureBlackbox_DCAuthWebServer Class)

Starts the server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_dcauthwebserver_do_start($res);

Remarks

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

Stop Method (SecureBlackbox_DCAuthWebServer Class)

Stops the server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_dcauthwebserver_do_stop($res);

Remarks

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

Accept Event (SecureBlackbox_DCAuthWebServer Class)

Reports an incoming connection.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 1, array($this, 'fireAccept'));

Parameter List

 'remoteaddress'
'remoteport'
'accept'

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

Fires when a connected client makes an authentication attempt.

Object Oriented Interface

public function fireAuthAttempt($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 2, array($this, 'fireAuthAttempt'));

Parameter List

 'connectionid'
'httpmethod'
'uri'
'authmethod'
'username'
'password'
'allow'

Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

Connect Event (SecureBlackbox_DCAuthWebServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 3, array($this, 'fireConnect'));

Parameter List

 'connectionid'
'remoteaddress'
'remoteport'

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.

CustomParametersReceived Event (SecureBlackbox_DCAuthWebServer Class)

Passes custom request parameters to the application.

Object Oriented Interface

public function fireCustomParametersReceived($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 4, array($this, 'fireCustomParametersReceived'));

Parameter List

 'connectionid'
'value'

Remarks

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

Disconnect Event (SecureBlackbox_DCAuthWebServer Class)

Fires to report a disconnected client.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 5, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client disconnects.

Error Event (SecureBlackbox_DCAuthWebServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'connectionid'
'errorcode'
'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (SecureBlackbox_DCAuthWebServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 7, array($this, 'fireExternalSign'));

Parameter List

 'connectionid'
'operationid'
'hashalgorithm'
'pars'
'data'
'signeddata'

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

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

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KeySecretNeeded Event (SecureBlackbox_DCAuthWebServer Class)

Requests the key secret from the application.

Object Oriented Interface

public function fireKeySecretNeeded($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 8, array($this, 'fireKeySecretNeeded'));

Parameter List

 'connectionid'
'keyid'
'keysecret'

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

Reports a single log line.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 9, array($this, 'fireLog'));

Parameter List

 'connectionid'
'logtype'
'details'

Remarks

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

Notification Event (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 10, array($this, 'fireNotification'));

Parameter List

 'eventid'
'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

ParameterReceived Event (SecureBlackbox_DCAuthWebServer Class)

Passes a standard request parameter to the user code.

Object Oriented Interface

public function fireParameterReceived($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 11, array($this, 'fireParameterReceived'));

Parameter List

 'connectionid'
'name'
'value'

Remarks

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

  • SessionID
  • DataURL
  • GoURL
  • Token
  • PKCS11Libraries
  • AllowFileStorage
  • AllowTokenStorage
  • AllowWindowsStorage
  • AllowOSStorage
Parameters are reported one-by-one upon being processed.

PasswordNeeded Event (SecureBlackbox_DCAuthWebServer Class)

Requests a password from the application.

Object Oriented Interface

public function firePasswordNeeded($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 12, array($this, 'firePasswordNeeded'));

Parameter List

 'neededfor'
'id'
'password'
'cancel'

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

Fires when the client sends in a read option request.

Object Oriented Interface

public function fireReadOption($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 13, array($this, 'fireReadOption'));

Parameter List

 'connectionid'
'name'
'value'
'success'

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

Requests certificate selection criteria from the application.

Object Oriented Interface

public function fireSelectCert($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 14, array($this, 'fireSelectCert'));

Parameter List

 'connectionid'
'commonname'
'keyid'
'keyusage'
'fingerprint'
'storetype'

Remarks

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

SignRequest Event (SecureBlackbox_DCAuthWebServer Class)

This event signifies the processing of an atomic signing request.

Object Oriented Interface

public function fireSignRequest($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 15, array($this, 'fireSignRequest'));

Parameter List

 'connectionid'
'method'
'hashalgorithm'
'hash'
'keyid'
'pars'
'methodpars'
'allow'

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:

asmdPKCS10
asmdPKCS71

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

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

Object Oriented Interface

public function fireSignRequestCompleted($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 16, array($this, 'fireSignRequestCompleted'));

Parameter List

 'connectionid'
'method'
'hashalgorithm'
'hash'
'keyid'
'pars'
'methodpars'
'signature'

Remarks

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

TimestampRequest Event (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface

public function fireTimestampRequest($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 17, array($this, 'fireTimestampRequest'));

Parameter List

 'tsa'
'timestamprequest'
'timestampresponse'
'suppressdefault'

Remarks

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

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

TLSCertValidate Event (SecureBlackbox_DCAuthWebServer Class)

Fires when a client certificate needs to be validated.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 18, array($this, 'fireTLSCertValidate'));

Parameter List

 'connectionid'
'accept'

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (SecureBlackbox_DCAuthWebServer Class)

Reports the setup of a TLS session.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 19, array($this, 'fireTLSEstablished'));

Parameter List

 'connectionid'

Remarks

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

TLSHandshake Event (SecureBlackbox_DCAuthWebServer Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 20, array($this, 'fireTLSHandshake'));

Parameter List

 'connectionid'
'servername'
'abort'

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

Requests a pre-shared key for TLS-PSK.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 21, array($this, 'fireTLSPSK'));

Parameter List

 'connectionid'
'identity'
'psk'
'ciphersuite'

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (SecureBlackbox_DCAuthWebServer Class)

Reports closure of a TLS session.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 22, array($this, 'fireTLSShutdown'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

WriteOption Event (SecureBlackbox_DCAuthWebServer Class)

Fires when the client sends in a write option request.

Object Oriented Interface

public function fireWriteOption($param);

Procedural Interface

secureblackbox_dcauthwebserver_register_callback($res, 23, array($this, 'fireWriteOption'));

Parameter List

 'connectionid'
'name'
'value'

Remarks

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

Config Settings (DCAuthWebServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (DCAuthWebServer Class)