OfficeSigner Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeSigner class signs Office documents.

Class Name

SecureBlackbox_OfficeSigner

Procedural Interface

 secureblackbox_officesigner_open();
 secureblackbox_officesigner_close($res);
 secureblackbox_officesigner_register_callback($res, $id, $function);
 secureblackbox_officesigner_get_last_error($res);
 secureblackbox_officesigner_get_last_error_code($res);
 secureblackbox_officesigner_set($res, $id, $index, $value);
 secureblackbox_officesigner_get($res, $id, $index);
 secureblackbox_officesigner_do_addtimestampvalidationdata($res, $sigindex);
 secureblackbox_officesigner_do_addvalidationdatarefs($res, $sigindex);
 secureblackbox_officesigner_do_addvalidationdatavalues($res, $sigindex);
 secureblackbox_officesigner_do_close($res, $savechanges);
 secureblackbox_officesigner_do_config($res, $configurationstring);
 secureblackbox_officesigner_do_doaction($res, $actionid, $actionparams);
 secureblackbox_officesigner_do_extractasyncdata($res, $asyncreply);
 secureblackbox_officesigner_do_open($res);
 secureblackbox_officesigner_do_revalidate($res, $sigindex);
 secureblackbox_officesigner_do_sign($res);
 secureblackbox_officesigner_do_signasyncbegin($res);
 secureblackbox_officesigner_do_signasyncend($res, $asyncreply);
 secureblackbox_officesigner_do_signexternal($res);
 secureblackbox_officesigner_do_timestamp($res, $sigindex, $timestamptype);
 secureblackbox_officesigner_do_upgrade($res, $sigindex, $toform);

Remarks

OfficeSigner provides digital signing capabilities of Office documents, and provides support for extended facilities, such as timestamps and advanced (XAdES) signatures.

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.

AutoValidateSignatures Property (SecureBlackbox_OfficeSigner Class)

Specifies whether class should validate any present signatures when the document is opened.

Object Oriented Interface

public function getAutoValidateSignatures();


public function setAutoValidateSignatures($value);

Procedural Interface

secureblackbox_officesigner_get($res, 1 );


secureblackbox_officesigner_set($res, 1, $value );

Default Value

false

Remarks

This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the Revalidate method.

Data Type

Boolean

BlockedCertCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 2 );


secureblackbox_officesigner_set($res, 2, $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_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 3 , $blockedcertindex);

Remarks

Returns the 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_OfficeSigner 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_officesigner_get($res, 10 , $blockedcertindex);


secureblackbox_officesigner_set($res, 10, $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_OfficeSigner Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_officesigner_get($res, 37 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 38 , $certindex);

Remarks

Returns the 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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 39 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the 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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 40 , $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_OfficeSigner 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_officesigner_get($res, 41 , $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_OfficeSigner Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 42 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 43 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 44 , $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_OfficeSigner 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_officesigner_get($res, 45 , $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_OfficeSigner 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_officesigner_get($res, 46 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 47 , $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_OfficeSigner 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_officesigner_get($res, 48 , $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_OfficeSigner Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 49 , $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_OfficeSigner Class)

Returns the length of the public key.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 50 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 51 , $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_OfficeSigner 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_officesigner_get($res, 52 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 53 , $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_OfficeSigner 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_officesigner_get($res, 54 , $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_OfficeSigner Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 57 , $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_OfficeSigner Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 61 , $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_OfficeSigner 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_officesigner_get($res, 63 , $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_OfficeSigner Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 64 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 65 , $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_OfficeSigner 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_officesigner_get($res, 66 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 68 , $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_OfficeSigner 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_officesigner_get($res, 69 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 70 , $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_OfficeSigner Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_officesigner_get($res, 71 , $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

CRLCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the CRL arrays.

Object Oriented Interface

public function getCRLCount();

Procedural Interface

secureblackbox_officesigner_get($res, 72 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CRLBytes
• CRLHandle
• CRLIssuer
• CRLIssuerRDN
• CRLLocation
• CRLNextUpdate
• CRLThisUpdate

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

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

Data Type

Integer

CRLBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getCRLBytes($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 73 , $crlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

CRLHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getCRLHandle($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 76 , $crlindex);

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

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

Data Type

Long64

CRLIssuer Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getCRLIssuer($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 77 , $crlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CRLIssuerRDN Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getCRLIssuerRDN($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 78 , $crlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CRLLocation Property (SecureBlackbox_OfficeSigner Class)

The URL that the CRL was downloaded from.

Object Oriented Interface

public function getCRLLocation($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 79 , $crlindex);

Default Value

''

Remarks

The URL that the CRL was downloaded from.

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

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

Data Type

String

CRLNextUpdate Property (SecureBlackbox_OfficeSigner Class)

The planned time and date of the next version of this CRL to be published.

Object Oriented Interface

public function getCRLNextUpdate($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 80 , $crlindex);

Default Value

''

Remarks

The planned time and date of the next version of this CRL to be published.

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

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

Data Type

String

CRLThisUpdate Property (SecureBlackbox_OfficeSigner Class)

The date and time at which this version of the CRL was published.

Object Oriented Interface

public function getCRLThisUpdate($crlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 83 , $crlindex);

Default Value

''

Remarks

The date and time at which this version of the CRL was published.

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

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

Data Type

String

DocumentFormat Property (SecureBlackbox_OfficeSigner Class)

Defines the format of the Office document.

Object Oriented Interface

public function getDocumentFormat();

Procedural Interface

secureblackbox_officesigner_get($res, 84 );

Default Value

0

Remarks

This property contains the Office document format.

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

Data Type

Integer

DocumentType Property (SecureBlackbox_OfficeSigner Class)

Defines the type of the Office document.

Object Oriented Interface

public function getDocumentType();

Procedural Interface

secureblackbox_officesigner_get($res, 85 );

Default Value

''

Remarks

This property contains the Office document type.

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

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_officesigner_get($res, 86 );


secureblackbox_officesigner_set($res, 86, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_officesigner_get($res, 87 );


secureblackbox_officesigner_set($res, 87, $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_OfficeSigner 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_officesigner_get($res, 88 );


secureblackbox_officesigner_set($res, 88, $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_OfficeSigner 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_officesigner_get($res, 89 );


secureblackbox_officesigner_set($res, 89, $value );

Default Value

false

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_officesigner_get($res, 90 );


secureblackbox_officesigner_set($res, 90, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 91 );


secureblackbox_officesigner_set($res, 91, $value );

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_OfficeSigner Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_officesigner_get($res, 92 );


secureblackbox_officesigner_set($res, 92, $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_OfficeSigner Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_officesigner_get($res, 93 );


secureblackbox_officesigner_set($res, 93, $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_OfficeSigner Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_officesigner_get($res, 94 );


secureblackbox_officesigner_set($res, 94, $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_OfficeSigner Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_officesigner_get($res, 95 );


secureblackbox_officesigner_set($res, 95, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_OfficeSigner Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_officesigner_get($res, 96 );


secureblackbox_officesigner_set($res, 96, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

IgnoreChainValidationErrors Property (SecureBlackbox_OfficeSigner Class)

Makes the class tolerant to chain validation errors.

Object Oriented Interface

public function getIgnoreChainValidationErrors();


public function setIgnoreChainValidationErrors($value);

Procedural Interface

secureblackbox_officesigner_get($res, 97 );


secureblackbox_officesigner_set($res, 97, $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

InputBytes Property (SecureBlackbox_OfficeSigner Class)

Use this property to pass the input to class in byte array form.

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_officesigner_get($res, 98 );


secureblackbox_officesigner_set($res, 98, $value );

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecureBlackbox_OfficeSigner Class)

The file to be signed.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_officesigner_get($res, 99 );


secureblackbox_officesigner_set($res, 99, $value );

Default Value

''

Remarks

Provide the path to the Office document to be signed.

Data Type

String

KnownCertCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 100 );


secureblackbox_officesigner_set($res, 100, $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_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 101 , $knowncertindex);

Remarks

Returns the 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_OfficeSigner 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_officesigner_get($res, 108 , $knowncertindex);


secureblackbox_officesigner_set($res, 108, $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_OfficeSigner Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 135 );


secureblackbox_officesigner_set($res, 135, $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_OfficeSigner Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_officesigner_get($res, 136 , $knowncrlindex);

Remarks

Returns the 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_OfficeSigner 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_officesigner_get($res, 139 , $knowncrlindex);


secureblackbox_officesigner_set($res, 139, $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_OfficeSigner Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 147 );


secureblackbox_officesigner_set($res, 147, $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_OfficeSigner Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 148 , $knownocspindex);

Remarks

A buffer containing the 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_OfficeSigner 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_officesigner_get($res, 150 , $knownocspindex);


secureblackbox_officesigner_set($res, 150, $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

NewSigCertificateIndex Property (SecureBlackbox_OfficeSigner Class)

Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection.

Object Oriented Interface

public function getNewSigCertificateIndex();

Procedural Interface

secureblackbox_officesigner_get($res, 155 );

Default Value

-1

Remarks

Returns the index of the signing certificate in the Certificates collection

Use this property to look up the signing certificate in the Certificates collection.

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

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

Data Type

Integer

NewSigChainValidationDetails Property (SecureBlackbox_OfficeSigner Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getNewSigChainValidationDetails();

Procedural Interface

secureblackbox_officesigner_get($res, 156 );

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

NewSigChainValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getNewSigChainValidationResult();

Procedural Interface

secureblackbox_officesigner_get($res, 157 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

NewSigClaimedSigningTime Property (SecureBlackbox_OfficeSigner Class)

The signing time from the signer's computer.

Object Oriented Interface

public function getNewSigClaimedSigningTime();


public function setNewSigClaimedSigningTime($value);

Procedural Interface

secureblackbox_officesigner_get($res, 158 );


secureblackbox_officesigner_set($res, 158, $value );

Default Value

''

Remarks

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

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

This property is not available at design time.

Data Type

String

NewSigCorePropertiesSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if this signature covers the core properties of the document.

Object Oriented Interface

public function getNewSigCorePropertiesSigned();


public function setNewSigCorePropertiesSigned($value);

Procedural Interface

secureblackbox_officesigner_get($res, 159 );


secureblackbox_officesigner_set($res, 159, $value );

Default Value

false

Remarks

Returns True if this signature covers the core properties of the document.

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

This property is not available at design time.

Data Type

Boolean

NewSigDocumentSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if the signature covers the document itself.

Object Oriented Interface

public function getNewSigDocumentSigned();


public function setNewSigDocumentSigned($value);

Procedural Interface

secureblackbox_officesigner_get($res, 160 );


secureblackbox_officesigner_set($res, 160, $value );

Default Value

false

Remarks

Returns True if the signature covers the document itself.

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

This property is not available at design time.

Data Type

Boolean

NewSigExpireTime Property (SecureBlackbox_OfficeSigner Class)

Specifies the signature expiration time in UTC.

Object Oriented Interface

public function getNewSigExpireTime();

Procedural Interface

secureblackbox_officesigner_get($res, 161 );

Default Value

''

Remarks

Specifies the signature expiration time in UTC.

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

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

Data Type

String

NewSigHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getNewSigHandle();


public function setNewSigHandle($value);

Procedural Interface

secureblackbox_officesigner_get($res, 162 );


secureblackbox_officesigner_set($res, 162, $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());

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

This property is not available at design time.

Data Type

Long64

NewSigHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

The hash algorithm used for signing.

Object Oriented Interface

public function getNewSigHashAlgorithm();


public function setNewSigHashAlgorithm($value);

Procedural Interface

secureblackbox_officesigner_get($res, 163 );


secureblackbox_officesigner_set($res, 163, $value );

Default Value

'Unknown'

Remarks

The hash algorithm used for signing.

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

This property is not available at design time.

Data Type

String

NewSigIssuerRDN Property (SecureBlackbox_OfficeSigner Class)

The Relative Distinguished Name of the signing certificate's issuer.

Object Oriented Interface

public function getNewSigIssuerRDN();

Procedural Interface

secureblackbox_officesigner_get($res, 164 );

Default Value

''

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

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

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

Data Type

String

NewSigLastArchivalTime Property (SecureBlackbox_OfficeSigner Class)

Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.

Object Oriented Interface

public function getNewSigLastArchivalTime();

Procedural Interface

secureblackbox_officesigner_get($res, 165 );

Default Value

''

Remarks

Indicates the most recent archival time of an archived signature

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.

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

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

Data Type

String

NewSigPolicyHash Property (SecureBlackbox_OfficeSigner Class)

The signature policy hash value.

Object Oriented Interface

public function getNewSigPolicyHash();


public function setNewSigPolicyHash($value);

Procedural Interface

secureblackbox_officesigner_get($res, 166 );


secureblackbox_officesigner_set($res, 166, $value );

Default Value

''

Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

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

This property is not available at design time.

Data Type

String

NewSigPolicyHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.

Object Oriented Interface

public function getNewSigPolicyHashAlgorithm();


public function setNewSigPolicyHashAlgorithm($value);

Procedural Interface

secureblackbox_officesigner_get($res, 167 );


secureblackbox_officesigner_set($res, 167, $value );

Default Value

''

Remarks

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from NewSigPolicyHash.

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

This property is not available at design time.

Data Type

String

NewSigPolicyID Property (SecureBlackbox_OfficeSigner Class)

The policy ID that was included or to be included into the signature.

Object Oriented Interface

public function getNewSigPolicyID();


public function setNewSigPolicyID($value);

Procedural Interface

secureblackbox_officesigner_get($res, 168 );


secureblackbox_officesigner_set($res, 168, $value );

Default Value

''

Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

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

This property is not available at design time.

Data Type

String

NewSigPolicyURI Property (SecureBlackbox_OfficeSigner Class)

The signature policy URI that was included in the signature.

Object Oriented Interface

public function getNewSigPolicyURI();


public function setNewSigPolicyURI($value);

Procedural Interface

secureblackbox_officesigner_get($res, 169 );


secureblackbox_officesigner_set($res, 169, $value );

Default Value

''

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

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

This property is not available at design time.

Data Type

String

NewSigSerialNumber Property (SecureBlackbox_OfficeSigner Class)

The serial number of the timestamp.

Object Oriented Interface

public function getNewSigSerialNumber();

Procedural Interface

secureblackbox_officesigner_get($res, 170 );

Remarks

The serial number of the timestamp.

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

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

Data Type

Byte Array

NewSigSignatureBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the binary representation of the Office signature.

Object Oriented Interface

public function getNewSigSignatureBytes();

Procedural Interface

secureblackbox_officesigner_get($res, 171 );

Remarks

Returns the binary representation of the Office signature.

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

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

Data Type

Byte Array

NewSigSignatureInfoComments Property (SecureBlackbox_OfficeSigner Class)

Contains the comments for the SignatureInfoText.

Object Oriented Interface

public function getNewSigSignatureInfoComments();


public function setNewSigSignatureInfoComments($value);

Procedural Interface

secureblackbox_officesigner_get($res, 172 );


secureblackbox_officesigner_set($res, 172, $value );

Default Value

''

Remarks

Contains the comments for the SignatureInfoText.

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

This property is not available at design time.

Data Type

String

NewSigSignatureInfoText Property (SecureBlackbox_OfficeSigner Class)

Contains the text of the signature info.

Object Oriented Interface

public function getNewSigSignatureInfoText();


public function setNewSigSignatureInfoText($value);

Procedural Interface

secureblackbox_officesigner_get($res, 173 );


secureblackbox_officesigner_set($res, 173, $value );

Default Value

''

Remarks

Contains the text of the signature info.

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

This property is not available at design time.

Data Type

String

NewSigSignatureOriginSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if the signature origin is signed.

Object Oriented Interface

public function getNewSigSignatureOriginSigned();


public function setNewSigSignatureOriginSigned($value);

Procedural Interface

secureblackbox_officesigner_get($res, 174 );


secureblackbox_officesigner_set($res, 174, $value );

Default Value

false

Remarks

Returns True if the signature origin is signed.

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

This property is not available at design time.

Data Type

Boolean

NewSigSignatureType Property (SecureBlackbox_OfficeSigner Class)

Specifies the type of this signature.

Object Oriented Interface

public function getNewSigSignatureType();


public function setNewSigSignatureType($value);

Procedural Interface

secureblackbox_officesigner_get($res, 175 );


secureblackbox_officesigner_set($res, 175, $value );

Default Value

0

Remarks

Specifies the type of this signature.

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

This property is not available at design time.

Data Type

Integer

NewSigSignatureValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getNewSigSignatureValidationResult();

Procedural Interface

secureblackbox_officesigner_get($res, 176 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

NewSigSubjectKeyID Property (SecureBlackbox_OfficeSigner Class)

Contains the subject key identifier of the signing certificate.

Object Oriented Interface

public function getNewSigSubjectKeyID();

Procedural Interface

secureblackbox_officesigner_get($res, 177 );

Remarks

Contains the subject key identifier of the signing certificate.

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 by a SHA-1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

NewSigSubjectRDN Property (SecureBlackbox_OfficeSigner Class)

Contains information about the person owning the signing certificate.

Object Oriented Interface

public function getNewSigSubjectRDN();

Procedural Interface

secureblackbox_officesigner_get($res, 178 );

Default Value

''

Remarks

Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.

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

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

Data Type

String

NewSigTimestamped Property (SecureBlackbox_OfficeSigner Class)

Use this property to establish whether the signature contains an embedded timestamp.

Object Oriented Interface

public function getNewSigTimestamped();

Procedural Interface

secureblackbox_officesigner_get($res, 179 );

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

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

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

Data Type

Boolean

NewSigValidatedSigningTime Property (SecureBlackbox_OfficeSigner Class)

Contains the certified signing time.

Object Oriented Interface

public function getNewSigValidatedSigningTime();

Procedural Interface

secureblackbox_officesigner_get($res, 180 );

Default Value

''

Remarks

Contains the certified signing time.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.

NewSigClaimedSigningTime returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

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

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

Data Type

String

NewSigValidationLog Property (SecureBlackbox_OfficeSigner Class)

Contains the complete log of the certificate validation routine.

Object Oriented Interface

public function getNewSigValidationLog();

Procedural Interface

secureblackbox_officesigner_get($res, 181 );

Default Value

''

Remarks

Contains the complete log of the certificate validation routine.

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.

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

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

Data Type

String

NewSigXAdES Property (SecureBlackbox_OfficeSigner Class)

Specifies whether the document contains an advanced signature (XAdES).

Object Oriented Interface

public function getNewSigXAdES();


public function setNewSigXAdES($value);

Procedural Interface

secureblackbox_officesigner_get($res, 182 );


secureblackbox_officesigner_set($res, 182, $value );

Default Value

true

Remarks

Specifies whether the document contains an advanced signature (XAdES).

Use this property to check whether the document is signed with XAdES or XML-DSIG only.

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

This property is not available at design time.

Data Type

Boolean

NewSigXAdESForm Property (SecureBlackbox_OfficeSigner Class)

Specifies which form of XAdES should be produced.

Object Oriented Interface

public function getNewSigXAdESForm();


public function setNewSigXAdESForm($value);

Procedural Interface

secureblackbox_officesigner_get($res, 183 );


secureblackbox_officesigner_set($res, 183, $value );

Default Value

0

Remarks

Specifies which form of XAdES should be produced.

Use this property to specify the form (level) of advanced electronic signature to be produced.

The supported forms are:

* XAdES-E-* forms are supported starting from XAdES v1.3.2

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

This property is not available at design time.

Data Type

Integer

NewSigXAdESVersion Property (SecureBlackbox_OfficeSigner Class)

Specifies XAdES version.

Object Oriented Interface

public function getNewSigXAdESVersion();


public function setNewSigXAdESVersion($value);

Procedural Interface

secureblackbox_officesigner_get($res, 184 );


secureblackbox_officesigner_set($res, 184, $value );

Default Value

3

Remarks

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.

The supported vesions are:

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

This property is not available at design time.

Data Type

Integer

OCSPCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the OCSP arrays.

Object Oriented Interface

public function getOCSPCount();

Procedural Interface

secureblackbox_officesigner_get($res, 185 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OCSPBytes
• OCSPHandle
• OCSPIssuer
• OCSPIssuerRDN
• OCSPLocation
• OCSPProducedAt

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

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

Data Type

Integer

OCSPBytes Property (SecureBlackbox_OfficeSigner Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getOCSPBytes($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 186 , $ocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

OCSPHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getOCSPHandle($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 188 , $ocspindex);

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

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

Data Type

Long64

OCSPIssuer Property (SecureBlackbox_OfficeSigner Class)

Indicates the issuer of this response (a CA or its authorized representative).

Object Oriented Interface

public function getOCSPIssuer($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 189 , $ocspindex);

Default Value

''

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

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

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

Data Type

String

OCSPIssuerRDN Property (SecureBlackbox_OfficeSigner Class)

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Object Oriented Interface

public function getOCSPIssuerRDN($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 190 , $ocspindex);

Default Value

''

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

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

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

Data Type

String

OCSPLocation Property (SecureBlackbox_OfficeSigner Class)

The location of the OCSP responder.

Object Oriented Interface

public function getOCSPLocation($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 191 , $ocspindex);

Default Value

''

Remarks

The location of the OCSP responder.

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

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

Data Type

String

OCSPProducedAt Property (SecureBlackbox_OfficeSigner Class)

Specifies the time when the response was produced, in UTC.

Object Oriented Interface

public function getOCSPProducedAt($ocspindex);

Procedural Interface

secureblackbox_officesigner_get($res, 192 , $ocspindex);

Default Value

''

Remarks

Specifies the time when the response was produced, in UTC.

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

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

Data Type

String

OfflineMode Property (SecureBlackbox_OfficeSigner Class)

Switches the class to offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_officesigner_get($res, 193 );


secureblackbox_officesigner_set($res, 193, $value );

Default Value

false

Remarks

When working in offline mode, the class 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 the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

OutputBytes Property (SecureBlackbox_OfficeSigner Class)

Use this property to read the output the class object has produced.

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_officesigner_get($res, 194 );

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_OfficeSigner Class)

Defines where to save the signed document.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_officesigner_get($res, 195 );


secureblackbox_officesigner_set($res, 195, $value );

Default Value

''

Remarks

Specifies the path where the signed Office document should be saved.

Data Type

String

Profile Property (SecureBlackbox_OfficeSigner Class)

Specifies a pre-defined profile to apply when creating the signature.

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_officesigner_get($res, 196 );


secureblackbox_officesigner_set($res, 196, $value );

Default Value

''

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ProxyAddress Property (SecureBlackbox_OfficeSigner Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_officesigner_get($res, 197 );


secureblackbox_officesigner_set($res, 197, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_OfficeSigner Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_officesigner_get($res, 198 );


secureblackbox_officesigner_set($res, 198, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_OfficeSigner Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_officesigner_get($res, 199 );


secureblackbox_officesigner_set($res, 199, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_OfficeSigner Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_officesigner_get($res, 200 );


secureblackbox_officesigner_set($res, 200, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_OfficeSigner Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_officesigner_get($res, 201 );


secureblackbox_officesigner_set($res, 201, $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_OfficeSigner Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_officesigner_get($res, 202 );


secureblackbox_officesigner_set($res, 202, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_officesigner_get($res, 203 );


secureblackbox_officesigner_set($res, 203, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 204 );


secureblackbox_officesigner_set($res, 204, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 205 );


secureblackbox_officesigner_set($res, 205, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_OfficeSigner Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_officesigner_get($res, 206 );


secureblackbox_officesigner_set($res, 206, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_OfficeSigner Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_officesigner_get($res, 207 );


secureblackbox_officesigner_set($res, 207, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RevocationCheck Property (SecureBlackbox_OfficeSigner Class)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Object Oriented Interface

public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface

secureblackbox_officesigner_get($res, 208 );


secureblackbox_officesigner_set($res, 208, $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 (CRLs) 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 for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

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

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

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

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

Data Type

Integer

SignatureCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the Signature arrays.

Object Oriented Interface

public function getSignatureCount();

Procedural Interface

secureblackbox_officesigner_get($res, 209 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCertificateIndex
• SignatureChainValidationDetails
• SignatureChainValidationResult
• SignatureClaimedSigningTime
• SignatureCorePropertiesSigned
• SignatureDocumentSigned
• SignatureExpireTime
• SignatureHandle
• SignatureHashAlgorithm
• SignatureIssuerRDN
• SignatureLastArchivalTime
• SignaturePolicyHash
• SignaturePolicyHashAlgorithm
• SignaturePolicyID
• SignaturePolicyURI
• SignatureSerialNumber
• SignatureSignatureBytes
• SignatureSignatureInfoComments
• SignatureSignatureInfoText
• SignatureSignatureOriginSigned
• SignatureSignatureType
• SignatureSignatureValidationResult
• SignatureSubjectKeyID
• SignatureSubjectRDN
• SignatureTimestamped
• SignatureValidatedSigningTime
• SignatureValidationLog
• SignatureXAdES
• SignatureXAdESForm
• SignatureXAdESVersion

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

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

Data Type

Integer

SignatureCertificateIndex Property (SecureBlackbox_OfficeSigner Class)

Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection.

Object Oriented Interface

public function getSignatureCertificateIndex($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 210 , $signatureindex);

Default Value

-1

Remarks

Returns the index of the signing certificate in the Certificates collection

Use this property to look up the signing certificate in the Certificates collection.

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

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

Data Type

Integer

SignatureChainValidationDetails Property (SecureBlackbox_OfficeSigner Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getSignatureChainValidationDetails($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 211 , $signatureindex);

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

SignatureChainValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getSignatureChainValidationResult($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 212 , $signatureindex);

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

SignatureClaimedSigningTime Property (SecureBlackbox_OfficeSigner Class)

The signing time from the signer's computer.

Object Oriented Interface

public function getSignatureClaimedSigningTime($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 213 , $signatureindex);

Default Value

''

Remarks

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

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

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

Data Type

String

SignatureCorePropertiesSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if this signature covers the core properties of the document.

Object Oriented Interface

public function getSignatureCorePropertiesSigned($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 214 , $signatureindex);

Default Value

false

Remarks

Returns True if this signature covers the core properties of the document.

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

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

Data Type

Boolean

SignatureDocumentSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if the signature covers the document itself.

Object Oriented Interface

public function getSignatureDocumentSigned($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 215 , $signatureindex);

Default Value

false

Remarks

Returns True if the signature covers the document itself.

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

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

Data Type

Boolean

SignatureExpireTime Property (SecureBlackbox_OfficeSigner Class)

Specifies the signature expiration time in UTC.

Object Oriented Interface

public function getSignatureExpireTime($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 216 , $signatureindex);

Default Value

''

Remarks

Specifies the signature expiration time in UTC.

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

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

Data Type

String

SignatureHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getSignatureHandle($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 217 , $signatureindex);

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

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

Data Type

Long64

SignatureHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

The hash algorithm used for signing.

Object Oriented Interface

public function getSignatureHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 218 , $signatureindex);

Default Value

'Unknown'

Remarks

The hash algorithm used for signing.

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

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

Data Type

String

SignatureIssuerRDN Property (SecureBlackbox_OfficeSigner Class)

The Relative Distinguished Name of the signing certificate's issuer.

Object Oriented Interface

public function getSignatureIssuerRDN($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 219 , $signatureindex);

Default Value

''

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

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

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

Data Type

String

SignatureLastArchivalTime Property (SecureBlackbox_OfficeSigner Class)

Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.

Object Oriented Interface

public function getSignatureLastArchivalTime($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 220 , $signatureindex);

Default Value

''

Remarks

Indicates the most recent archival time of an archived signature

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.

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

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

Data Type

String

SignaturePolicyHash Property (SecureBlackbox_OfficeSigner Class)

The signature policy hash value.

Object Oriented Interface

public function getSignaturePolicyHash($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 221 , $signatureindex);

Default Value

''

Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

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

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

Data Type

String

SignaturePolicyHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.

Object Oriented Interface

public function getSignaturePolicyHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 222 , $signatureindex);

Default Value

''

Remarks

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from SignaturePolicyHash.

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

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

Data Type

String

SignaturePolicyID Property (SecureBlackbox_OfficeSigner Class)

The policy ID that was included or to be included into the signature.

Object Oriented Interface

public function getSignaturePolicyID($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 223 , $signatureindex);

Default Value

''

Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

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

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

Data Type

String

SignaturePolicyURI Property (SecureBlackbox_OfficeSigner Class)

The signature policy URI that was included in the signature.

Object Oriented Interface

public function getSignaturePolicyURI($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 224 , $signatureindex);

Default Value

''

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

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

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

Data Type

String

SignatureSerialNumber Property (SecureBlackbox_OfficeSigner Class)

The serial number of the timestamp.

Object Oriented Interface

public function getSignatureSerialNumber($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 225 , $signatureindex);

Remarks

The serial number of the timestamp.

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

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

Data Type

Byte Array

SignatureSignatureBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the binary representation of the Office signature.

Object Oriented Interface

public function getSignatureSignatureBytes($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 226 , $signatureindex);

Remarks

Returns the binary representation of the Office signature.

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

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

Data Type

Byte Array

SignatureSignatureInfoComments Property (SecureBlackbox_OfficeSigner Class)

Contains the comments for the SignatureInfoText.

Object Oriented Interface

public function getSignatureSignatureInfoComments($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 227 , $signatureindex);

Default Value

''

Remarks

Contains the comments for the SignatureInfoText.

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

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

Data Type

String

SignatureSignatureInfoText Property (SecureBlackbox_OfficeSigner Class)

Contains the text of the signature info.

Object Oriented Interface

public function getSignatureSignatureInfoText($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 228 , $signatureindex);

Default Value

''

Remarks

Contains the text of the signature info.

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

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

Data Type

String

SignatureSignatureOriginSigned Property (SecureBlackbox_OfficeSigner Class)

Returns True if the signature origin is signed.

Object Oriented Interface

public function getSignatureSignatureOriginSigned($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 229 , $signatureindex);

Default Value

false

Remarks

Returns True if the signature origin is signed.

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

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

Data Type

Boolean

SignatureSignatureType Property (SecureBlackbox_OfficeSigner Class)

Specifies the type of this signature.

Object Oriented Interface

public function getSignatureSignatureType($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 230 , $signatureindex);

Default Value

0

Remarks

Specifies the type of this signature.

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

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

Data Type

Integer

SignatureSignatureValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSignatureSignatureValidationResult($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 231 , $signatureindex);

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

SignatureSubjectKeyID Property (SecureBlackbox_OfficeSigner Class)

Contains the subject key identifier of the signing certificate.

Object Oriented Interface

public function getSignatureSubjectKeyID($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 232 , $signatureindex);

Remarks

Contains the subject key identifier of the signing certificate.

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 by a SHA-1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

SignatureSubjectRDN Property (SecureBlackbox_OfficeSigner Class)

Contains information about the person owning the signing certificate.

Object Oriented Interface

public function getSignatureSubjectRDN($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 233 , $signatureindex);

Default Value

''

Remarks

Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.

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

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

Data Type

String

SignatureTimestamped Property (SecureBlackbox_OfficeSigner Class)

Use this property to establish whether the signature contains an embedded timestamp.

Object Oriented Interface

public function getSignatureTimestamped($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 234 , $signatureindex);

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

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

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

Data Type

Boolean

SignatureValidatedSigningTime Property (SecureBlackbox_OfficeSigner Class)

Contains the certified signing time.

Object Oriented Interface

public function getSignatureValidatedSigningTime($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 235 , $signatureindex);

Default Value

''

Remarks

Contains the certified signing time.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.

SignatureClaimedSigningTime returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

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

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

Data Type

String

SignatureValidationLog Property (SecureBlackbox_OfficeSigner Class)

Contains the complete log of the certificate validation routine.

Object Oriented Interface

public function getSignatureValidationLog($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 236 , $signatureindex);

Default Value

''

Remarks

Contains the complete log of the certificate validation routine.

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.

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

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

Data Type

String

SignatureXAdES Property (SecureBlackbox_OfficeSigner Class)

Specifies whether the document contains an advanced signature (XAdES).

Object Oriented Interface

public function getSignatureXAdES($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 237 , $signatureindex);

Default Value

true

Remarks

Specifies whether the document contains an advanced signature (XAdES).

Use this property to check whether the document is signed with XAdES or XML-DSIG only.

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

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

Data Type

Boolean

SignatureXAdESForm Property (SecureBlackbox_OfficeSigner Class)

Specifies which form of XAdES should be produced.

Object Oriented Interface

public function getSignatureXAdESForm($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 238 , $signatureindex);

Default Value

0

Remarks

Specifies which form of XAdES should be produced.

Use this property to specify the form (level) of advanced electronic signature to be produced.

The supported forms are:

* XAdES-E-* forms are supported starting from XAdES v1.3.2

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

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

Data Type

Integer

SignatureXAdESVersion Property (SecureBlackbox_OfficeSigner Class)

Specifies XAdES version.

Object Oriented Interface

public function getSignatureXAdESVersion($signatureindex);

Procedural Interface

secureblackbox_officesigner_get($res, 239 , $signatureindex);

Default Value

3

Remarks

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.

The supported vesions are:

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

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

Data Type

Integer

SignedPartCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the SignedPart arrays.

Object Oriented Interface

public function getSignedPartCount();

Procedural Interface

secureblackbox_officesigner_get($res, 240 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignedPartContentType
• SignedPartHashAlgorithm
• SignedPartIsRelationshipPart
• SignedPartPath
• SignedPartSignatureIndex
• SignedPartValidationResult

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

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

Data Type

Integer

SignedPartContentType Property (SecureBlackbox_OfficeSigner Class)

Specifies the content type of this signed part.

Object Oriented Interface

public function getSignedPartContentType($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 241 , $signedpartindex);

Default Value

''

Remarks

Specifies the content type of this signed part.

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

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

Data Type

String

SignedPartHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

The hash algorithm used for signing.

Object Oriented Interface

public function getSignedPartHashAlgorithm($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 242 , $signedpartindex);

Default Value

'Unknown'

Remarks

The hash algorithm used for signing.

The hash algorithm used for signing.

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

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

Data Type

String

SignedPartIsRelationshipPart Property (SecureBlackbox_OfficeSigner Class)

Specifies whether this signed part is a relationship part.

Object Oriented Interface

public function getSignedPartIsRelationshipPart($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 243 , $signedpartindex);

Default Value

false

Remarks

Specifies whether this signed part is a relationship part.

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

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

Data Type

Boolean

SignedPartPath Property (SecureBlackbox_OfficeSigner Class)

The path to this signed part in the document package.

Object Oriented Interface

public function getSignedPartPath($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 244 , $signedpartindex);

Default Value

''

Remarks

The path to this signed part in the document package.

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

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

Data Type

String

SignedPartSignatureIndex Property (SecureBlackbox_OfficeSigner Class)

Returns the index of the owner signature, if applicable.

Object Oriented Interface

public function getSignedPartSignatureIndex($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 245 , $signedpartindex);

Default Value

-1

Remarks

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

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

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

Data Type

Integer

SignedPartValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSignedPartValidationResult($signedpartindex);

Procedural Interface

secureblackbox_officesigner_get($res, 246 , $signedpartindex);

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_officesigner_get($res, 247 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 254 );


secureblackbox_officesigner_set($res, 254, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 281 );


secureblackbox_officesigner_set($res, 281, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_officesigner_get($res, 282 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_officesigner_get($res, 289 , $signingchainindex);


secureblackbox_officesigner_set($res, 289, $value , $signingchainindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

SocketDNSMode Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 316 );


secureblackbox_officesigner_set($res, 316, $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_OfficeSigner 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_officesigner_get($res, 317 );


secureblackbox_officesigner_set($res, 317, $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_OfficeSigner Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_officesigner_get($res, 318 );


secureblackbox_officesigner_set($res, 318, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 319 );


secureblackbox_officesigner_set($res, 319, $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_OfficeSigner Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_officesigner_get($res, 320 );


secureblackbox_officesigner_set($res, 320, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 321 );


secureblackbox_officesigner_set($res, 321, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_OfficeSigner Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_officesigner_get($res, 322 );


secureblackbox_officesigner_set($res, 322, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_OfficeSigner Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_officesigner_get($res, 323 );


secureblackbox_officesigner_set($res, 323, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 324 );


secureblackbox_officesigner_set($res, 324, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 325 );


secureblackbox_officesigner_set($res, 325, $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_OfficeSigner Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_officesigner_get($res, 326 );


secureblackbox_officesigner_set($res, 326, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TimestampCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the Timestamp arrays.

Object Oriented Interface

public function getTimestampCount();

Procedural Interface

secureblackbox_officesigner_get($res, 327 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TimestampAccuracy
• TimestampBytes
• TimestampCertificateIndex
• TimestampChainValidationDetails
• TimestampChainValidationResult
• TimestampHashAlgorithm
• TimestampSerialNumber
• TimestampSignatureIndex
• TimestampTime
• TimestampTimestampType
• TimestampTSAName
• TimestampValidationLog
• TimestampValidationResult

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

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

Data Type

Integer

TimestampAccuracy Property (SecureBlackbox_OfficeSigner Class)

This property indicates the accuracy of the included time mark, in microseconds.

Object Oriented Interface

public function getTimestampAccuracy($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 328 , $timestampindex);

Default Value

0

Remarks

This field indicates the accuracy of the included time mark, in microseconds.

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

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

Data Type

Long64

TimestampBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw timestamp data in DER format.

Object Oriented Interface

public function getTimestampBytes($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 329 , $timestampindex);

Remarks

Returns the raw timestamp data in DER format.

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

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

Data Type

Byte Array

TimestampCertificateIndex Property (SecureBlackbox_OfficeSigner Class)

Returns the index of the TSA certificate in the Certificates collection.

Object Oriented Interface

public function getTimestampCertificateIndex($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 330 , $timestampindex);

Default Value

-1

Remarks

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

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

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

Data Type

Integer

TimestampChainValidationDetails Property (SecureBlackbox_OfficeSigner Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getTimestampChainValidationDetails($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 331 , $timestampindex);

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

TimestampChainValidationResult Property (SecureBlackbox_OfficeSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getTimestampChainValidationResult($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 332 , $timestampindex);

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

TimestampHashAlgorithm Property (SecureBlackbox_OfficeSigner Class)

Returns the timestamp's hash algorithm.

Object Oriented Interface

public function getTimestampHashAlgorithm($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 333 , $timestampindex);

Default Value

''

Remarks

Returns the timestamp's hash algorithm.

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

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

Data Type

String

TimestampSerialNumber Property (SecureBlackbox_OfficeSigner Class)

Returns the timestamp's serial number.

Object Oriented Interface

public function getTimestampSerialNumber($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 334 , $timestampindex);

Remarks

Returns the timestamp's serial number.

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

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

Data Type

Byte Array

TimestampSignatureIndex Property (SecureBlackbox_OfficeSigner Class)

Returns the index of the owner signature, if applicable.

Object Oriented Interface

public function getTimestampSignatureIndex($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 335 , $timestampindex);

Default Value

-1

Remarks

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

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

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

Data Type

Integer

TimestampTime Property (SecureBlackbox_OfficeSigner Class)

The time point incorporated into the timestamp.

Object Oriented Interface

public function getTimestampTime($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 336 , $timestampindex);

Default Value

''

Remarks

The time point incorporated into the timestamp.

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

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

Data Type

String

TimestampTimestampType Property (SecureBlackbox_OfficeSigner Class)

Returns the type of the timestamp.

Object Oriented Interface

public function getTimestampTimestampType($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 337 , $timestampindex);

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

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

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

Data Type

Integer

TimestampTSAName Property (SecureBlackbox_OfficeSigner Class)

This value uniquely identifies the Timestamp Authority (TSA).

Object Oriented Interface

public function getTimestampTSAName($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 338 , $timestampindex);

Default Value

''

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

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

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

Data Type

String

TimestampValidationLog Property (SecureBlackbox_OfficeSigner Class)

Contains the TSA certificate chain validation log.

Object Oriented Interface

public function getTimestampValidationLog($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 339 , $timestampindex);

Default Value

''

Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

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

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

Data Type

String

TimestampValidationResult Property (SecureBlackbox_OfficeSigner Class)

Contains the timestamp validation outcome.

Object Oriented Interface

public function getTimestampValidationResult($timestampindex);

Procedural Interface

secureblackbox_officesigner_get($res, 340 , $timestampindex);

Default Value

0

Remarks

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

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

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

Data Type

Integer

TimestampServer Property (SecureBlackbox_OfficeSigner Class)

The address of the timestamping server.

Object Oriented Interface

public function getTimestampServer();


public function setTimestampServer($value);

Procedural Interface

secureblackbox_officesigner_get($res, 341 );


secureblackbox_officesigner_set($res, 341, $value );

Default Value

''

Remarks

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

Data Type

String

TLSClientCertCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 342 );


secureblackbox_officesigner_set($res, 342, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 343 , $tlsclientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);


public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_officesigner_get($res, 350 , $tlsclientcertindex);


secureblackbox_officesigner_set($res, 350, $value , $tlsclientcertindex);

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

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_officesigner_get($res, 377 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

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

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 378 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSServerCertHandle Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 385 , $tlsservercertindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

TLSAutoValidateCertificates Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 412 );


secureblackbox_officesigner_set($res, 412, $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_OfficeSigner Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_officesigner_get($res, 413 );


secureblackbox_officesigner_set($res, 413, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_OfficeSigner Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_officesigner_get($res, 414 );


secureblackbox_officesigner_set($res, 414, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSECCurves Property (SecureBlackbox_OfficeSigner Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_officesigner_get($res, 415 );


secureblackbox_officesigner_set($res, 415, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_OfficeSigner Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_officesigner_get($res, 416 );


secureblackbox_officesigner_set($res, 416, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 417 );


secureblackbox_officesigner_set($res, 417, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 418 );


secureblackbox_officesigner_set($res, 418, $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_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_officesigner_get($res, 419 );


secureblackbox_officesigner_set($res, 419, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_officesigner_get($res, 420 );


secureblackbox_officesigner_set($res, 420, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_OfficeSigner Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_officesigner_get($res, 421 );


secureblackbox_officesigner_set($res, 421, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_officesigner_get($res, 422 );


secureblackbox_officesigner_set($res, 422, $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 for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 423 );


secureblackbox_officesigner_set($res, 423, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_OfficeSigner Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_officesigner_get($res, 424 );


secureblackbox_officesigner_set($res, 424, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_officesigner_get($res, 425 );


secureblackbox_officesigner_set($res, 425, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_OfficeSigner Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_officesigner_get($res, 426 );


secureblackbox_officesigner_set($res, 426, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_OfficeSigner Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_officesigner_get($res, 427 );


secureblackbox_officesigner_set($res, 427, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_OfficeSigner Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_officesigner_get($res, 428 );


secureblackbox_officesigner_set($res, 428, $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_OfficeSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_officesigner_get($res, 429 , $trustedcertindex);

Remarks

Returns the 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_OfficeSigner 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_officesigner_get($res, 436 , $trustedcertindex);


secureblackbox_officesigner_set($res, 436, $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

ValidationMoment Property (SecureBlackbox_OfficeSigner 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_officesigner_get($res, 463 );


secureblackbox_officesigner_set($res, 463, $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 the signature creation time or the 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

AddTimestampValidationData Method (SecureBlackbox_OfficeSigner Class)

Use this method to add timestamp validation data to the signature.

Object Oriented Interface

public function doAddTimestampValidationData($sigindex);

Procedural Interface

secureblackbox_officesigner_do_addtimestampvalidationdata($res, $sigindex);

Remarks

Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataRefs Method (SecureBlackbox_OfficeSigner Class)

Use this method to add signature validation references to the signature.

Object Oriented Interface

public function doAddValidationDataRefs($sigindex);

Procedural Interface

secureblackbox_officesigner_do_addvalidationdatarefs($res, $sigindex);

Remarks

Call this method to add references to certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataValues Method (SecureBlackbox_OfficeSigner Class)

Use this method to add signature validation values to the signature.

Object Oriented Interface

public function doAddValidationDataValues($sigindex);

Procedural Interface

secureblackbox_officesigner_do_addvalidationdatavalues($res, $sigindex);

Remarks

Call this method to add certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

Close Method (SecureBlackbox_OfficeSigner Class)

Closes an opened document.

Object Oriented Interface

public function doClose($savechanges);

Procedural Interface

secureblackbox_officesigner_do_close($res, $savechanges);

Remarks

Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.

Config Method (SecureBlackbox_OfficeSigner Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_officesigner_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoAction Method (SecureBlackbox_OfficeSigner Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Remarks

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

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

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

ExtractAsyncData Method (SecureBlackbox_OfficeSigner Class)

Extracts user data from the DC signing service response.

Object Oriented Interface

public function doExtractAsyncData($asyncreply);

Procedural Interface

secureblackbox_officesigner_do_extractasyncdata($res, $asyncreply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

Open Method (SecureBlackbox_OfficeSigner Class)

Opens a document for signing or updating.

Object Oriented Interface

public function doOpen();

Procedural Interface

secureblackbox_officesigner_do_open($res);

Remarks

Use this method to open a document for signing or updating. When finished, call Close to complete or discard the operation.

Revalidate Method (SecureBlackbox_OfficeSigner Class)

Revalidates a signature in accordance with current settings.

Object Oriented Interface

public function doRevalidate($sigindex);

Procedural Interface

secureblackbox_officesigner_do_revalidate($res, $sigindex);

Remarks

Use this method to re-validate a signature in the opened Office document.

Sign Method (SecureBlackbox_OfficeSigner Class)

Calculates the signature value.

Object Oriented Interface

public function doSign();

Procedural Interface

secureblackbox_officesigner_do_sign($res);

Remarks

Call this method to generate a signature over the document.

SignAsyncBegin Method (SecureBlackbox_OfficeSigner Class)

Initiates the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncBegin();

Procedural Interface

secureblackbox_officesigner_do_signasyncbegin($res);

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (SecureBlackbox_OfficeSigner Class)

Completes the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncEnd($asyncreply);

Procedural Interface

secureblackbox_officesigner_do_signasyncend($res, $asyncreply);

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignExternal Method (SecureBlackbox_OfficeSigner Class)

Signs the document using an external signing facility.

Object Oriented Interface

public function doSignExternal();

Procedural Interface

secureblackbox_officesigner_do_signexternal($res);

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the class fires ExternalSign event which allows to pass the hash value for signing.

Timestamp Method (SecureBlackbox_OfficeSigner Class)

Use this method to add an timestamp.

Object Oriented Interface

public function doTimestamp($sigindex, $timestamptype);

Procedural Interface

secureblackbox_officesigner_do_timestamp($res, $sigindex, $timestamptype);

Remarks

Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in SignatureValidated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create

Supported timestamp types:

Upgrade Method (SecureBlackbox_OfficeSigner Class)

Upgrades existing XAdES signature to a new form.

Object Oriented Interface

public function doUpgrade($sigindex, $toform);

Procedural Interface

secureblackbox_officesigner_do_upgrade($res, $sigindex, $toform);

Remarks

XAdES standard defines a number of different 'forms' of signatures which can be used for different purposes. Use this method to upgrade XAdES signature to a new form specified by ToForm. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).

The supported forms are:

ChainElementDownload Event (SecureBlackbox_OfficeSigner Class)

Fires when there is a need to download a chain element from an online source.

Object Oriented Interface

public function fireChainElementDownload($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 1, array($this, 'fireChainElementDownload'));

Parameter List

 'kind'
 'certrdn'
 'cacertrdn'
 'location'
 'action'

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

ChainElementNeeded Event (SecureBlackbox_OfficeSigner Class)

Fires when an element required to validate the chain was not located.

Object Oriented Interface

public function fireChainElementNeeded($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 2, array($this, 'fireChainElementNeeded'));

Parameter List

 'kind'
 'certrdn'
 'cacertrdn'

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

ChainElementStore Event (SecureBlackbox_OfficeSigner Class)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Object Oriented Interface

public function fireChainElementStore($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 3, array($this, 'fireChainElementStore'));

Parameter List

 'kind'
 'body'
 'uri'

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.

ChainValidated Event (SecureBlackbox_OfficeSigner Class)

Reports the completion of a certificate chain validation.

Object Oriented Interface

public function fireChainValidated($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 4, array($this, 'fireChainValidated'));

Parameter List

 'index'
 'subjectrdn'
 'validationresult'
 'validationdetails'

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

ChainValidationProgress Event (SecureBlackbox_OfficeSigner Class)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Object Oriented Interface

public function fireChainValidationProgress($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 5, array($this, 'fireChainValidationProgress'));

Parameter List

 'eventkind'
 'certrdn'
 'cacertrdn'
 'action'

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

DocumentLoaded Event (SecureBlackbox_OfficeSigner Class)

This event is fired when the document has been loaded into memory.

Object Oriented Interface

public function fireDocumentLoaded($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 6, array($this, 'fireDocumentLoaded'));

Parameter List

 'cancel'

Remarks

The handler for this event is a good place to check document properties, which may be useful when preparing the signature, for example, the document format.

Set Cancel to true to terminate document processing on this stage.

Error Event (SecureBlackbox_OfficeSigner Class)

Information about errors during signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

This event is fired in case of exceptional conditions during the office document processing.

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

ExternalSign Event (SecureBlackbox_OfficeSigner Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 8, array($this, 'fireExternalSign'));

Parameter List

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

Remarks

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

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

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

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

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

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

Notification Event (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 9, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

This class can fire this event with the following EventID values:

SignatureFound Event (SecureBlackbox_OfficeSigner Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 10, array($this, 'fireSignatureFound'));

Parameter List

 'index'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatesignature'
 'validatechain'

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (SecureBlackbox_OfficeSigner Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 11, array($this, 'fireSignatureValidated'));

Parameter List

 'index'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'validationresult'

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

TimestampFound Event (SecureBlackbox_OfficeSigner Class)

Signifies the start of a timestamp validation routine.

Object Oriented Interface

public function fireTimestampFound($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 12, array($this, 'fireTimestampFound'));

Parameter List

 'index'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatetimestamp'
 'validatechain'

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampRequest Event (SecureBlackbox_OfficeSigner Class)

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

Object Oriented Interface

public function fireTimestampRequest($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 13, array($this, 'fireTimestampRequest'));

Parameter List

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

Remarks

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

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

TimestampValidated Event (SecureBlackbox_OfficeSigner Class)

Reports the completion of the timestamp validation routine.

Object Oriented Interface

public function fireTimestampValidated($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 14, array($this, 'fireTimestampValidated'));

Parameter List

 'index'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'time'
 'validationresult'
 'chainvalidationresult'
 'chainvalidationdetails'

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

TLSCertNeeded Event (SecureBlackbox_OfficeSigner Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 15, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (SecureBlackbox_OfficeSigner Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 16, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (SecureBlackbox_OfficeSigner Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 17, array($this, 'fireTLSEstablished'));

Parameter List

 'host'
 'version'
 'ciphersuite'
 'connectionid'
 'abort'

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SecureBlackbox_OfficeSigner Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 18, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (SecureBlackbox_OfficeSigner Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_officesigner_register_callback($res, 19, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

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

OfficeSigner Config Settings

Base Config Settings

Trappable Errors (OfficeSigner Class)

OfficeSigner Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	24117249   Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS)
	24117250   Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT)
	24117251   Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE)
	24117252   Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED)
	24117253   Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED)
	24117254   Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE)
	24117255   Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED)
	24117256   Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION)
	24117257   Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD)
	24117258   Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND)