Authenticator Class

Properties   Methods   Events   Config Settings   Errors  

The Authenticator class specializes in user authentication.

Class Name

SecureBlackbox_Authenticator

Procedural Interface

 secureblackbox_authenticator_open();
 secureblackbox_authenticator_close($res);
 secureblackbox_authenticator_register_callback($res, $id, $function);
 secureblackbox_authenticator_get_last_error($res);
 secureblackbox_authenticator_get_last_error_code($res);
 secureblackbox_authenticator_set($res, $id, $index, $value);
 secureblackbox_authenticator_get($res, $id, $index);
 secureblackbox_authenticator_do_config($res, $configurationstring);
 secureblackbox_authenticator_do_continueauth($res, $state, $authtoken);
 secureblackbox_authenticator_do_doaction($res, $actionid, $actionparams);
 secureblackbox_authenticator_do_startauth($res, $userid);

Remarks

Authenticator provides capabilities for implementing the authenticating party (as opposed to the one being authenticated) of the authentication protocol.

Authenticator can be used in a variety of authentication scenarios, ranging from simple password checks to complicated multi-factor variants. It also supports authentication via a SBB-own DC protocol, which makes it a good pair for DCAuth control.

In default configuration the component uses the attached database of users to handle authentication requests. The authentication flow can be altered if needed to match specific authentication requirements.

In Authenticator's terms, the authentication process is divided into a sequence of atomic steps. Each step is characterized by a user providing an authentication token - such as a password or PIN - and the authenticator validating that token. Each validation step may result in one of the following outcomes:

• Authentication succeeded: the authentication has been completed with the positive outcome;
• Authentication failed: the authentication process has failed, the user didn't provide enough evidence to confirm they are who they claim they are;
• Further authentication is required: the authentication was partly successful, but the settings of the component or user details require further step(s) to be taken.

Use the following logic when integrating the Authenticator into your project:

• Whenever you receive an authentication request from a user, call the StartAuth method, passing the UserID as a parameter. This initiates the authentication procedure: the Authenticator control looks up the user in the Users database and picks the first authentication method. It then returns the Further authentication is required result and stores the details of the first authentication step in AuthInfo property. Apart from the information about the authentication method that is to be performed during this step, AuthInfo also contains a > value, which accumulates parameters and progress of the user's authentication flow. You can save the state value on this stage, and restore it later when a response from the user is received. With that in mind, class is stateless; you can save the current authentication state in a database, and return to it from a different context.
• Now that you have obtained Further authentication needed from StartAuth, it's time to check the > and request the corresponding token from the user. For example, if the method is 'password', you may present the user with a password dialog.
• Upon receiving a password (or other kind of authentication token) from the user, pass it to the ContinueAuth method, together with the state object that you saved on the preceding step. The component will process the token and come up with one of the three results given above, signifying the end of the first authentication step. If Further authentication is required result is returned, another authentication step needs to be performed (either because a multi-factor authentication is configured for this user, or because an alternative authentication method was chosen following failure of the previous attempt). If that is the case, follow the guidance for StartAuth-initiated step above.

  Depending on the settings, many authentication steps may need to be performed, so your code may ultimately end up calling ContinueAuth many times.

class can be customized to use external user information sources instead of a predefined user database. AuthStart, AuthVerify, and AuthAttemptResult events provide an opportunity for your code to intervene into the authentication process by defining your own authentication procedures and validating authentication tokens manually.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AuthInfoAuthLog Property (SecureBlackbox_Authenticator Class)

Contains the authentication log.

Object Oriented Interface

public function getAuthInfoAuthLog();

Procedural Interface

secureblackbox_authenticator_get($res, 1 );

Default Value

''

Remarks

Contains the authentication log. This can be used for accountability purposes.

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

Data Type

String

AuthInfoAuthMethod Property (SecureBlackbox_Authenticator Class)

Contains the current authentication method.

Object Oriented Interface

public function getAuthInfoAuthMethod();

Procedural Interface

secureblackbox_authenticator_get($res, 2 );

Default Value

''

Remarks

Contains the current authentication method.

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

Data Type

String

AuthInfoAuthMethodPars Property (SecureBlackbox_Authenticator Class)

Contains the authentication method parameters.

Object Oriented Interface

public function getAuthInfoAuthMethodPars();

Procedural Interface

secureblackbox_authenticator_get($res, 3 );

Default Value

''

Remarks

Contains the authentication method parameters. These are method-dependent. For example, the dcauth method will have a DC request in this property.

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

Data Type

String

AuthInfoCompletedMethods Property (SecureBlackbox_Authenticator Class)

Contains a comma-separated list of completed authentication methods.

Object Oriented Interface

public function getAuthInfoCompletedMethods();

Procedural Interface

secureblackbox_authenticator_get($res, 4 );

Default Value

''

Remarks

Contains a comma-separated list of completed authentication methods.

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

Data Type

String

AuthInfoLastAuthMessage Property (SecureBlackbox_Authenticator Class)

Contains an uninterpreted authentication message to be displayed to the authenticating user.

Object Oriented Interface

public function getAuthInfoLastAuthMessage();

Procedural Interface

secureblackbox_authenticator_get($res, 5 );

Default Value

''

Remarks

Contains an uninterpreted authentication message to be displayed to the authenticating user.

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

Data Type

String

AuthInfoLastAuthResult Property (SecureBlackbox_Authenticator Class)

Contains the result of the last authentication token validation.

Object Oriented Interface

public function getAuthInfoLastAuthResult();

Procedural Interface

secureblackbox_authenticator_get($res, 6 );

Default Value

-1

Remarks

Contains the result of the last authentication token validation.

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

Data Type

Integer

AuthInfoRemainingMethods Property (SecureBlackbox_Authenticator Class)

Contains a comma-separated list of authentication methods yet to perform.

Object Oriented Interface

public function getAuthInfoRemainingMethods();

Procedural Interface

secureblackbox_authenticator_get($res, 7 );

Default Value

''

Remarks

Contains a comma-separated list of authentication methods yet to perform.

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

Data Type

String

AuthInfoState Property (SecureBlackbox_Authenticator Class)

Contains a state of the overall authentication process.

Object Oriented Interface

public function getAuthInfoState();

Procedural Interface

secureblackbox_authenticator_get($res, 8 );

Default Value

''

Remarks

Contains a state of the overall authentication process. Save the content of this property after calling StartAuth or ContinueAuth to remember the setup of the authenticator control, and pass it to the next ContinueAuth call to resume from the same stage.

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

Data Type

String

AuthInfoUserID Property (SecureBlackbox_Authenticator Class)

Returns the ID of the user being authenticated, as passed to StartAuth .

Object Oriented Interface

public function getAuthInfoUserID();

Procedural Interface

secureblackbox_authenticator_get($res, 9 );

Default Value

''

Remarks

Returns the ID of the user being authenticated, as passed to StartAuth.

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

Data Type

String

BlockedCertCount Property (SecureBlackbox_Authenticator Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 10 );


secureblackbox_authenticator_set($res, 10, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_Authenticator Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_authenticator_get($res, 11 , $blockedcertindex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 18 , $blockedcertindex);


secureblackbox_authenticator_set($res, 18, $value , $blockedcertindex);

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

This property is not available at design time.

Data Type

Long64

CertCount Property (SecureBlackbox_Authenticator Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_authenticator_get($res, 45 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertCA
• CertCAKeyID
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertPolicyIDs
• CertPublicKeyBytes
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSubject
• CertSubjectKeyID
• CertSubjectRDN
• CertValidFrom
• CertValidTo

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

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

Data Type

Integer

CertBytes Property (SecureBlackbox_Authenticator Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 46 , $certindex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

CertCA Property (SecureBlackbox_Authenticator Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 47 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

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

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

Data Type

Boolean

CertCAKeyID Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 48 , $certindex);

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

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

Data Type

Byte Array

CertCRLDistributionPoints Property (SecureBlackbox_Authenticator Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Object Oriented Interface

public function getCertCRLDistributionPoints($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 49 , $certindex);

Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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

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

Data Type

String

CertCurve Property (SecureBlackbox_Authenticator Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 50 , $certindex);

Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

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

Data Type

String

CertFingerprint Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 51 , $certindex);

Remarks

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

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

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

Data Type

Byte Array

CertFriendlyName Property (SecureBlackbox_Authenticator Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 52 , $certindex);

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate.

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

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

Data Type

String

CertHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertHandle($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 53 , $certindex);

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

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

Data Type

Long64

CertHashAlgorithm Property (SecureBlackbox_Authenticator Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface

public function getCertHashAlgorithm($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 54 , $certindex);

Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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

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

Data Type

String

CertIssuer Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 55 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertIssuerRDN Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 56 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertKeyAlgorithm Property (SecureBlackbox_Authenticator Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 57 , $certindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

CertKeyBits Property (SecureBlackbox_Authenticator Class)

Returns the length of the public key.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 58 , $certindex);

Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

CertKeyFingerprint Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 59 , $certindex);

Remarks

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

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

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

Data Type

Byte Array

CertKeyUsage Property (SecureBlackbox_Authenticator 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 getCertKeyUsage($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 60 , $certindex);

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:

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

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

Data Type

Integer

CertKeyValid Property (SecureBlackbox_Authenticator Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 61 , $certindex);

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

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

Data Type

Boolean

CertOCSPLocations Property (SecureBlackbox_Authenticator Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface

public function getCertOCSPLocations($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 62 , $certindex);

Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

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

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

Data Type

String

CertPolicyIDs Property (SecureBlackbox_Authenticator Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 65 , $certindex);

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

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

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

Data Type

String

CertPublicKeyBytes Property (SecureBlackbox_Authenticator Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 69 , $certindex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

CertSelfSigned Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertSelfSigned($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 71 , $certindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CertSerialNumber Property (SecureBlackbox_Authenticator Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 72 , $certindex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

CertSigAlgorithm Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 73 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertSubject Property (SecureBlackbox_Authenticator 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 getCertSubject($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 74 , $certindex);

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

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

Data Type

String

CertSubjectKeyID Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 76 , $certindex);

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

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

Data Type

Byte Array

CertSubjectRDN Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 77 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertValidFrom Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 78 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertValidTo Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_authenticator_get($res, 79 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ChainValidationDetails Property (SecureBlackbox_Authenticator Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getChainValidationDetails();

Procedural Interface

secureblackbox_authenticator_get($res, 80 );

Default Value

0

Remarks

Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

ChainValidationResult Property (SecureBlackbox_Authenticator Class)

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Object Oriented Interface

public function getChainValidationResult();

Procedural Interface

secureblackbox_authenticator_get($res, 81 );

Default Value

0

Remarks

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

DefaultAuthMethods Property (SecureBlackbox_Authenticator Class)

Contains the list of default authentication methods.

Object Oriented Interface

public function getDefaultAuthMethods();


public function setDefaultAuthMethods($value);

Procedural Interface

secureblackbox_authenticator_get($res, 82 );


secureblackbox_authenticator_set($res, 82, $value );

Default Value

''

Remarks

Use this property to specify a list of default authentication methods to apply to users that are not included in the Users database. Assign this property with a comma-separated list of standard and custom authentication methods.

The following standard authentication methods are supported by the component:

• password
• otp-h
• otp-t
• dcauth

You can use any names not clashing with the standard methods to indicate your own custom authentication methods. Use CustomAuthStart and AuthVerify events to handle custom authentication methods.

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_authenticator_get($res, 83 );


secureblackbox_authenticator_set($res, 83, $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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_authenticator_get($res, 84 );


secureblackbox_authenticator_set($res, 84, $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_Authenticator 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_authenticator_get($res, 85 );


secureblackbox_authenticator_set($res, 85, $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_Authenticator 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_authenticator_get($res, 86 );


secureblackbox_authenticator_set($res, 86, $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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_Authenticator Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_authenticator_get($res, 87 );


secureblackbox_authenticator_set($res, 87, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 88 );


secureblackbox_authenticator_set($res, 88, $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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use 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_Authenticator Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_authenticator_get($res, 89 );


secureblackbox_authenticator_set($res, 89, $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_Authenticator Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_authenticator_get($res, 90 );


secureblackbox_authenticator_set($res, 90, $value );

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_Authenticator Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 91 );


secureblackbox_authenticator_set($res, 91, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_Authenticator Class)

Provide 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_authenticator_get($res, 92 );


secureblackbox_authenticator_set($res, 92, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_Authenticator Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 93 );


secureblackbox_authenticator_set($res, 93, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

IgnoreChainValidationErrors Property (SecureBlackbox_Authenticator Class)

Makes the class tolerant to chain validation errors.

Object Oriented Interface

public function getIgnoreChainValidationErrors();


public function setIgnoreChainValidationErrors($value);

Procedural Interface

secureblackbox_authenticator_get($res, 94 );


secureblackbox_authenticator_set($res, 94, $value );

Default Value

false

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

Boolean

KnownCertCount Property (SecureBlackbox_Authenticator Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 95 );


secureblackbox_authenticator_set($res, 95, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_Authenticator Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_authenticator_get($res, 96 , $knowncertindex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 103 , $knowncertindex);


secureblackbox_authenticator_set($res, 103, $value , $knowncertindex);

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SecureBlackbox_Authenticator Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 130 );


secureblackbox_authenticator_set($res, 130, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_Authenticator Class)

Returns raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_authenticator_get($res, 131 , $knowncrlindex);

Remarks

Returns raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 134 , $knowncrlindex);


secureblackbox_authenticator_set($res, 134, $value , $knowncrlindex);

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SecureBlackbox_Authenticator Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 142 );


secureblackbox_authenticator_set($res, 142, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_Authenticator Class)

Buffer containing raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_authenticator_get($res, 143 , $knownocspindex);

Remarks

Buffer containing raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 145 , $knownocspindex);


secureblackbox_authenticator_set($res, 145, $value , $knownocspindex);

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

This property is not available at design time.

Data Type

Long64

OfflineMode Property (SecureBlackbox_Authenticator Class)

Switches the class to the offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 150 );


secureblackbox_authenticator_set($res, 150, $value );

Default Value

false

Remarks

When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

ProxyAddress Property (SecureBlackbox_Authenticator Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_authenticator_get($res, 151 );


secureblackbox_authenticator_set($res, 151, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_Authenticator Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_authenticator_get($res, 152 );


secureblackbox_authenticator_set($res, 152, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_Authenticator Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_authenticator_get($res, 153 );


secureblackbox_authenticator_set($res, 153, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_Authenticator Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_authenticator_get($res, 154 );


secureblackbox_authenticator_set($res, 154, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_Authenticator Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_authenticator_get($res, 155 );


secureblackbox_authenticator_set($res, 155, $value );

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_Authenticator Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_authenticator_get($res, 156 );


secureblackbox_authenticator_set($res, 156, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_Authenticator Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_authenticator_get($res, 157 );


secureblackbox_authenticator_set($res, 157, $value );

Default Value

''

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_Authenticator Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_authenticator_get($res, 158 );


secureblackbox_authenticator_set($res, 158, $value );

Default Value

''

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_Authenticator Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_authenticator_get($res, 159 );


secureblackbox_authenticator_set($res, 159, $value );

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_Authenticator Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_authenticator_get($res, 160 );


secureblackbox_authenticator_set($res, 160, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_Authenticator Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_authenticator_get($res, 161 );


secureblackbox_authenticator_set($res, 161, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RevocationCheck Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface

secureblackbox_authenticator_get($res, 162 );


secureblackbox_authenticator_set($res, 162, $value );

Default Value

1

Remarks

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

Certificate Revocation Lists (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

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

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

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

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_Authenticator Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_authenticator_get($res, 163 );

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 170 );


secureblackbox_authenticator_set($res, 170, $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

SocketDNSMode Property (SecureBlackbox_Authenticator Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 197 );


secureblackbox_authenticator_set($res, 197, $value );

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_Authenticator Class)

Specifies the port number to be used for sending queries to the DNS server.

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_authenticator_get($res, 198 );


secureblackbox_authenticator_set($res, 198, $value );

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_Authenticator Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_authenticator_get($res, 199 );


secureblackbox_authenticator_set($res, 199, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_Authenticator Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_authenticator_get($res, 200 );


secureblackbox_authenticator_set($res, 200, $value );

Default Value

''

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_Authenticator Class)

The timeout (in milliseconds) for the whole resolution process.

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_authenticator_get($res, 201 );


secureblackbox_authenticator_set($res, 201, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 202 );


secureblackbox_authenticator_set($res, 202, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_Authenticator Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_authenticator_get($res, 203 );


secureblackbox_authenticator_set($res, 203, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_Authenticator Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_authenticator_get($res, 204 );


secureblackbox_authenticator_set($res, 204, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 205 );


secureblackbox_authenticator_set($res, 205, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 206 );


secureblackbox_authenticator_set($res, 206, $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_Authenticator Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_authenticator_get($res, 207 );


secureblackbox_authenticator_set($res, 207, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 208 );


secureblackbox_authenticator_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_Authenticator Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_authenticator_get($res, 209 );


secureblackbox_authenticator_set($res, 209, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_Authenticator Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_authenticator_get($res, 210 );


secureblackbox_authenticator_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 that allow to blanketly enable or disable all ciphersuites at once.

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

• 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_Authenticator Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_authenticator_get($res, 211 );


secureblackbox_authenticator_set($res, 211, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_Authenticator Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_authenticator_get($res, 212 );


secureblackbox_authenticator_set($res, 212, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 213 );


secureblackbox_authenticator_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_Authenticator 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_authenticator_get($res, 214 );


secureblackbox_authenticator_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_Authenticator Class)

Contains the pre-shared 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_authenticator_get($res, 215 );


secureblackbox_authenticator_set($res, 215, $value );

Default Value

''

Remarks

Contains the pre-shared 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_Authenticator Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_authenticator_get($res, 216 );


secureblackbox_authenticator_set($res, 216, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_Authenticator Class)

Selects renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 217 );


secureblackbox_authenticator_set($res, 217, $value );

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_authenticator_get($res, 218 );


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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 219 );


secureblackbox_authenticator_set($res, 219, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_Authenticator Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_authenticator_get($res, 220 );


secureblackbox_authenticator_set($res, 220, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_authenticator_get($res, 221 );


secureblackbox_authenticator_set($res, 221, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_Authenticator Class)

Enables or disables TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_authenticator_get($res, 222 );


secureblackbox_authenticator_set($res, 222, $value );

Default Value

false

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_Authenticator Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_authenticator_get($res, 223 );


secureblackbox_authenticator_set($res, 223, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_Authenticator Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 224 );


secureblackbox_authenticator_set($res, 224, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_Authenticator Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_authenticator_get($res, 225 , $trustedcertindex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 232 , $trustedcertindex);


secureblackbox_authenticator_set($res, 232, $value , $trustedcertindex);

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

This property is not available at design time.

Data Type

Long64

UserCount Property (SecureBlackbox_Authenticator Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();


public function setUserCount($value);

Procedural Interface

secureblackbox_authenticator_get($res, 259 );


secureblackbox_authenticator_set($res, 259, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCert
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserPasswordLen
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 260 , $userindex);


secureblackbox_authenticator_set($res, 260, $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_Authenticator 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_authenticator_get($res, 261 , $userindex);


secureblackbox_authenticator_set($res, 261, $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_Authenticator Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCert($userindex);


public function setUserCert($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 262 , $userindex);


secureblackbox_authenticator_set($res, 262, $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_Authenticator 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_authenticator_get($res, 263 , $userindex);


secureblackbox_authenticator_set($res, 263, $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_Authenticator 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_authenticator_get($res, 264 , $userindex);


secureblackbox_authenticator_set($res, 264, $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_Authenticator 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_authenticator_get($res, 265 , $userindex);


secureblackbox_authenticator_set($res, 265, $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:

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_Authenticator Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 266 , $userindex);


secureblackbox_authenticator_set($res, 266, $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

UserOtpAlgorithm Property (SecureBlackbox_Authenticator Class)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);


public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 267 , $userindex);


secureblackbox_authenticator_set($res, 267, $value , $userindex);

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

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

UserOtpValue Property (SecureBlackbox_Authenticator Class)

The user's time interval (TOTP) or Counter (HOTP).

Object Oriented Interface

public function getUserOtpValue($userindex);


public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 268 , $userindex);


secureblackbox_authenticator_set($res, 268, $value , $userindex);

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

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_Authenticator Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 269 , $userindex);


secureblackbox_authenticator_set($res, 269, $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_Authenticator Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 270 , $userindex);


secureblackbox_authenticator_set($res, 270, $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

UserPasswordLen Property (SecureBlackbox_Authenticator Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserPasswordLen($userindex);


public function setUserPasswordLen($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 271 , $userindex);


secureblackbox_authenticator_set($res, 271, $value , $userindex);

Default Value

0

Remarks

Specifies the length of the user's OTP 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

Integer

UserSharedSecret Property (SecureBlackbox_Authenticator 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_authenticator_get($res, 272 , $userindex);


secureblackbox_authenticator_set($res, 272, $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

UserSSHKey Property (SecureBlackbox_Authenticator Class)

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);


public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 273 , $userindex);


secureblackbox_authenticator_set($res, 273, $value , $userindex);

Remarks

Contains the user's SSH key.

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_Authenticator Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_authenticator_get($res, 274 , $userindex);


secureblackbox_authenticator_set($res, 274, $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

ValidationLog Property (SecureBlackbox_Authenticator Class)

Contains the complete log of the certificate validation routine.

Object Oriented Interface

public function getValidationLog();

Procedural Interface

secureblackbox_authenticator_get($res, 275 );

Default Value

''

Remarks

Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.

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

Data Type

String

ValidationMoment Property (SecureBlackbox_Authenticator Class)

The time point at which signature validity is to be established.

Object Oriented Interface

public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface

secureblackbox_authenticator_get($res, 276 );


secureblackbox_authenticator_set($res, 276, $value );

Default Value

''

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either signature creation time, or current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

Config Method (SecureBlackbox_Authenticator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

ContinueAuth Method (SecureBlackbox_Authenticator Class)

Call this method to process an authentication token and proceed to the next authentication step.

Object Oriented Interface

public function doContinueAuth($state, $authtoken);

Procedural Interface

secureblackbox_authenticator_do_continueauth($res, $state, $authtoken);

Remarks

Call this method upon receiving an authentication token from the user to validate it and proceed to the next authentication step (or complete the authentication).

Pass the authentication state blob that you obtained at the beginning of the authentication step to the State parameter, and the authentication credential received from the user to the AuthToken parameter. The method will validate the token and return one of the following results:

The further authentication needed result indicates that the user is expected to go through at least one more authentication step. Check AuthInfo property to find out which authentication method should be used on that step, and request the relevant authentication token from the user. Upon receiving that new token, call ContinueAuth again - and continue running this loop until authentication succeeded or authentication failed result is returned.

DoAction Method (SecureBlackbox_Authenticator Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_authenticator_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 insencitive) 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;....

StartAuth Method (SecureBlackbox_Authenticator Class)

Initiates an authentication process.

Object Oriented Interface

public function doStartAuth($userid);

Procedural Interface

secureblackbox_authenticator_do_startauth($res, $userid);

Remarks

Call this method to start an authentication process for UserID.

The authentication process may consist of multiple atomic steps. Each step represents a single authentication transaction, such as provision of a password, a PIN, or a one-time token. The exact authentication step sequence for the user is chosen according to the following rules:

• If the user is found in the Users database, all authentication methods specified for that user are activated;
• otherwise, the methods assigned to DefaultAuthMethods are activated;
• AuthStart event is thrown, allowing the application to tune up the selection of authentication methods if needed.
• the first method from the list is initiated.

This method may return one of the three results:

The authentication succeeded result is returned if the authentication method selection procedure completed with an empty method list. A typical result of this method though is further authentication required, which indicates that the next authentication method has kicked off. Use rpAuthInfo; property to find out which authentication method should be used on this step, and solicit the relevant authentication token from the user. Pass the received token to the ContinueAuth method for validation.

AuthAttemptResult Event (SecureBlackbox_Authenticator Class)

Reports the outcome of an authentication attempt.

Object Oriented Interface

public function fireAuthAttemptResult($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 1, array($this, 'fireAuthAttemptResult'));

Parameter List

 'userid'
 'authmethod'
 'authres'
 'remainingauthmethods'

Remarks

This event follows a call to ContinueAuth method and reports the user's updated authentication status following the token verification.

The updated status is reported via the AuthRes parameter, and can take one of the following values:

The RemainingAuthMethods parameter lists the authentication methods that the user is yet to go through. The application can change either of AuthRes and RemainingAuthMethods in the event handler to alter the authentication flow.

AuthAttemptStart Event (SecureBlackbox_Authenticator Class)

Signifies the start of an authentication attempt.

Object Oriented Interface

public function fireAuthAttemptStart($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 2, array($this, 'fireAuthAttemptStart'));

Parameter List

 'userid'
 'authmethod'
 'remainingauthmethods'

Remarks

This event reports the start of an atomic authentication step. The AuthMethod parameter contains the authentication method that has started. The following authentication methods are currently supported, but the application may define its own methods in AuthStart, and tune them up in CustomAuthStart:

• password
• otp-h
• otp-t
• dcauth

RemainingAuthMethods contains a list of authentication methods that will follow.

This event is thrown from StartAuth and ContinueAuth methods.

AuthStart Event (SecureBlackbox_Authenticator Class)

Signifies the start of an authentication process.

Object Oriented Interface

public function fireAuthStart($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 3, array($this, 'fireAuthStart'));

Parameter List

 'userid'
 'authmethods'

Remarks

This event is fired in response to a StartAuth call, and signifies the start of a (potentially, multi-step) authentication process for UserID. The AuthMethods parameter list the methods to be performed for the user. The application may customize them as needed.

The following default authentication methods are supported:

• password
• otp-h
• otp-t
• dcauth

The application can define its own authentication methods if needed.

This event is only fired once per user authentication process, at the very start of it. See AuthAttemptStart for per-step notification.

AuthVerify Event (SecureBlackbox_Authenticator Class)

Requests the application to validate an authentication token.

Object Oriented Interface

public function fireAuthVerify($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 4, array($this, 'fireAuthVerify'));

Parameter List

 'userid'
 'authmethod'
 'authtoken'
 'authmethoddata'
 'valid'

Remarks

Class fires this event to ask the application to validate an authentication token that it can't validate automatically. This can happen if UserID was not found in the user database or a custom authentication method is used.

AuthMethod and AuthToken specify the authentication method being used and the authentication token provided by the user. AuthMethodData contains an application-specific data provided by the application at the beginning of the authentication step.

An event handler subscribed to this event should validate the authentication token provided by the user and set the Valid parameter accordingly.

CustomAuthStart Event (SecureBlackbox_Authenticator Class)

Reports the beginning of a custom authentication method.

Object Oriented Interface

public function fireCustomAuthStart($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 5, array($this, 'fireCustomAuthStart'));

Parameter List

 'userid'
 'authmethod'
 'authmethodpars'
 'authmethoddata'

Remarks

This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application.

Class currently supports the following authentication methods:

• password
• otp-h
• otp-t
• dcauth

The application may also use any number of custom authentication method it wants. Each such method is identified by a unique string name (such as 'pin', 'fingerprint', or 'fingerprint-v2'). It may specify them in DefaultAuthMethods property, or provide on the fly via AuthStart event.

The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via AuthMethodPars and AuthMethodData parameters.

Error Event (SecureBlackbox_Authenticator Class)

Reports information about errors during authentication.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during user authentication.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_Authenticator Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_authenticator_register_callback($res, 7, 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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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

Config Settings (Authenticator 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.

DCAuthenticator Config Settings

Base Config Settings

Trappable Errors (Authenticator Class)