# OfficeSigner Class

The OfficeSigner class signs Office documents.

## Class Name

**SecureBlackbox_OfficeSigner**

## Procedural Interface

```text
 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_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_reset($res);
 secureblackbox_officesigner_do_revalidate($res, $siglabel);
 secureblackbox_officesigner_do_selectinfo($res, $entitylabel, $infotype, $clearselection);
 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, $siglabel, $timestamptype);
 secureblackbox_officesigner_do_upgrade($res, $siglabel, $upgradekind);
```

## Remarks

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

```text
OfficeSigner signer = new OfficeSigner();

// Select the file which you want to sign
signer.setInputFile("MyFile.docx");

// Set the path where you want the signed file to be saved
signer.setOutputFile("SignedFile.docx");

signer.getNewSignature().setHashAlgorithm("SHA512"); // Default hashing algorithm SHA256

signer.getNewSignature().setLevel(OfficeSignature.aslBaselineB); // Set the level of the signature

// Specify the certificate that shall be used for signing
signer.setSigningCertificate(new Certificate("Cert.pfx","password"));

// Whether to sign the document itself
signer.getNewSignature().setDocumentSigned(true);
// Whether to sign core properties of the document
signer.getNewSignature().setCorePropertiesSigned(true);
// Whether to sign signature origin
signer.getNewSignature().setSignatureOriginSigned(true);

signer.sign();
```

## Property List

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

|  |  |
| --- | --- |
| [AutoValidateSignatures](#autovalidatesignatures-property-secureblackbox_officesigner-class) | Specifies whether class should validate any present signatures when the document is opened. |
| [BlockedCertCount](#blockedcertcount-property-secureblackbox_officesigner-class) | The number of records in the BlockedCert arrays. |
| [BlockedCertBytes](#blockedcertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [BlockedCertHandle](#blockedcerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [CertCount](#certcount-property-secureblackbox_officesigner-class) | The number of records in the Cert arrays. |
| [CertBytes](#certbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [CertCA](#certca-property-secureblackbox_officesigner-class) | Indicates whether the certificate has a CA capability. |
| [CertCAKeyID](#certcakeyid-property-secureblackbox_officesigner-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [CertType](#certtype-property-secureblackbox_officesigner-class) | Returns the type of the entity contained in the Certificate object. |
| [CertCRLDistributionPoints](#certcrldistributionpoints-property-secureblackbox_officesigner-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [CertCurve](#certcurve-property-secureblackbox_officesigner-class) | Specifies the elliptic curve associated with the certificate's public key. |
| [CertFingerprint](#certfingerprint-property-secureblackbox_officesigner-class) | Contains the fingerprint (a hash imprint) of this certificate. |
| [CertFriendlyName](#certfriendlyname-property-secureblackbox_officesigner-class) | Contains an associated alias (friendly name) of the certificate. |
| [CertHandle](#certhandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [CertHashAlgorithm](#certhashalgorithm-property-secureblackbox_officesigner-class) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| [CertIssuer](#certissuer-property-secureblackbox_officesigner-class) | The common name of the certificate issuer (CA), typically a company name. |
| [CertIssuerRDN](#certissuerrdn-property-secureblackbox_officesigner-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [CertKeyAlgorithm](#certkeyalgorithm-property-secureblackbox_officesigner-class) | Specifies the public key algorithm of this certificate. |
| [CertKeyBits](#certkeybits-property-secureblackbox_officesigner-class) | Returns the length of the public key in bits. |
| [CertKeyFingerprint](#certkeyfingerprint-property-secureblackbox_officesigner-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [CertKeyUsage](#certkeyusage-property-secureblackbox_officesigner-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [CertKeyValid](#certkeyvalid-property-secureblackbox_officesigner-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [CertOCSPLocations](#certocsplocations-property-secureblackbox_officesigner-class) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| [CertOCSPNoCheck](#certocspnocheck-property-secureblackbox_officesigner-class) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [CertOrigin](#certorigin-property-secureblackbox_officesigner-class) | Returns the location that the certificate was taken or loaded from. |
| [CertPolicyIDs](#certpolicyids-property-secureblackbox_officesigner-class) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_officesigner-class) | Returns the certificate's private key in DER-encoded format. |
| [CertPrivateKeyExists](#certprivatekeyexists-property-secureblackbox_officesigner-class) | Indicates whether the certificate has a usable private key associated with it. |
| [CertPrivateKeyExtractable](#certprivatekeyextractable-property-secureblackbox_officesigner-class) | Indicates whether the private key is extractable (exportable). |
| [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_officesigner-class) | Contains the certificate's public key in DER format. |
| [CertQualified](#certqualified-property-secureblackbox_officesigner-class) | Indicates whether the certificate is qualified. |
| [CertQualifiedStatements](#certqualifiedstatements-property-secureblackbox_officesigner-class) | Returns a simplified qualified status of the certificate. |
| [CertQualifiers](#certqualifiers-property-secureblackbox_officesigner-class) | A list of qualifiers. |
| [CertSelfSigned](#certselfsigned-property-secureblackbox_officesigner-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [CertSerialNumber](#certserialnumber-property-secureblackbox_officesigner-class) | Returns the certificate's serial number. |
| [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_officesigner-class) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [CertSource](#certsource-property-secureblackbox_officesigner-class) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [CertSubject](#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. |
| [CertSubjectAlternativeName](#certsubjectalternativename-property-secureblackbox_officesigner-class) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_officesigner-class) | Contains a unique identifier of the certificate's cryptographic key. |
| [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_officesigner-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [CertValid](#certvalid-property-secureblackbox_officesigner-class) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. |
| [CertValidFrom](#certvalidfrom-property-secureblackbox_officesigner-class) | The time point at which the certificate becomes valid, in UTC. |
| [CertValidTo](#certvalidto-property-secureblackbox_officesigner-class) | The time point at which the certificate expires, in UTC. |
| [CheckTrustedLists](#checktrustedlists-property-secureblackbox_officesigner-class) | Specifies whether the class should attempt to validate chain trust via a known Trusted List. |
| [CRLCount](#crlcount-property-secureblackbox_officesigner-class) | The number of records in the CRL arrays. |
| [CRLBytes](#crlbytes-property-secureblackbox_officesigner-class) | Returns the raw CRL data in DER format. |
| [CRLCAKeyID](#crlcakeyid-property-secureblackbox_officesigner-class) | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
| [CRLEntryCount](#crlentrycount-property-secureblackbox_officesigner-class) | Returns the number of certificate status entries in the CRL. |
| [CRLHandle](#crlhandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [CRLIssuer](#crlissuer-property-secureblackbox_officesigner-class) | The common name of the CRL issuer (CA), typically a company name. |
| [CRLIssuerRDN](#crlissuerrdn-property-secureblackbox_officesigner-class) | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| [CRLLocation](#crllocation-property-secureblackbox_officesigner-class) | The URL that the CRL was downloaded from. |
| [CRLNextUpdate](#crlnextupdate-property-secureblackbox_officesigner-class) | The planned time and date of the next version of this CRL to be published. |
| [CRLSigAlgorithm](#crlsigalgorithm-property-secureblackbox_officesigner-class) | The public key algorithm that was used by the CA to sign this CRL. |
| [CRLSource](#crlsource-property-secureblackbox_officesigner-class) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [CRLTBS](#crltbs-property-secureblackbox_officesigner-class) | The to-be-signed part of the CRL (the CRL without the signature part). |
| [CRLThisUpdate](#crlthisupdate-property-secureblackbox_officesigner-class) | The date and time at which this version of the CRL was published. |
| [DocumentFormat](#documentformat-property-secureblackbox_officesigner-class) | Defines the format of the Office document. |
| [DocumentType](#documenttype-property-secureblackbox_officesigner-class) | Defines the type of the Office document. |
| [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_officesigner-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_officesigner-class) | Custom parameters to be passed to the signing service (uninterpreted). |
| [ExternalCryptoData](#externalcryptodata-property-secureblackbox_officesigner-class) | Additional data to be included in the async state and mirrored back by the requestor. |
| [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_officesigner-class) | Specifies whether the message hash is to be calculated at the external endpoint. |
| [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_officesigner-class) | Specifies the request's signature hash algorithm. |
| [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_officesigner-class) | The ID of the pre-shared key used for DC request authentication. |
| [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_officesigner-class) | The pre-shared key used for DC request authentication. |
| [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_officesigner-class) | Specifies the asynchronous signing method. |
| [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_officesigner-class) | Specifies the external cryptography mode. |
| [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_officesigner-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| [FIPSMode](#fipsmode-property-secureblackbox_officesigner-class) | Reserved. |
| [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-secureblackbox_officesigner-class) | Makes the class tolerant to chain validation errors. |
| [InputBytes](#inputbytes-property-secureblackbox_officesigner-class) | Use this property to pass the input to class in byte array form. |
| [InputFile](#inputfile-property-secureblackbox_officesigner-class) | The file to be signed. |
| [KnownCertCount](#knowncertcount-property-secureblackbox_officesigner-class) | The number of records in the KnownCert arrays. |
| [KnownCertBytes](#knowncertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [KnownCertHandle](#knowncerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [KnownCRLCount](#knowncrlcount-property-secureblackbox_officesigner-class) | The number of records in the KnownCRL arrays. |
| [KnownCRLBytes](#knowncrlbytes-property-secureblackbox_officesigner-class) | Returns the raw CRL data in DER format. |
| [KnownCRLHandle](#knowncrlhandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [KnownOCSPCount](#knownocspcount-property-secureblackbox_officesigner-class) | The number of records in the KnownOCSP arrays. |
| [KnownOCSPBytes](#knownocspbytes-property-secureblackbox_officesigner-class) | A buffer containing the raw OCSP response data. |
| [KnownOCSPHandle](#knownocsphandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [NewSigChainValidationDetails](#newsigchainvalidationdetails-property-secureblackbox_officesigner-class) | The details of a certificate chain validation outcome. |
| [NewSigChainValidationResult](#newsigchainvalidationresult-property-secureblackbox_officesigner-class) | The outcome of a certificate chain validation routine. |
| [NewSigClaimedSigningTime](#newsigclaimedsigningtime-property-secureblackbox_officesigner-class) | The signing time from the signer's computer. |
| [NewSigCompatibilityErrors](#newsigcompatibilityerrors-property-secureblackbox_officesigner-class) | Returns compatibility errors encountered during validation. |
| [NewSigContainsLongTermInfo](#newsigcontainslongterminfo-property-secureblackbox_officesigner-class) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| [NewSigCorePropertiesSigned](#newsigcorepropertiessigned-property-secureblackbox_officesigner-class) | Returns True if this signature covers the core properties of the document. |
| [NewSigDocumentSigned](#newsigdocumentsigned-property-secureblackbox_officesigner-class) | Returns True if the signature covers the document itself. |
| [NewSigEntityLabel](#newsigentitylabel-property-secureblackbox_officesigner-class) | Use this property to get the signature entity label. |
| [NewSigExpireTime](#newsigexpiretime-property-secureblackbox_officesigner-class) | Specifies the signature expiration time in UTC. |
| [NewSigHandle](#newsighandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [NewSigHashAlgorithm](#newsighashalgorithm-property-secureblackbox_officesigner-class) | The hash algorithm used for signing. |
| [NewSigIssuerRDN](#newsigissuerrdn-property-secureblackbox_officesigner-class) | The Relative Distinguished Name of the signing certificate's issuer. |
| [NewSigLastArchivalTime](#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. |
| [NewSigLevel](#newsiglevel-property-secureblackbox_officesigner-class) | Specifies which level or form of XAdES should be produced. |
| [NewSigPolicyHash](#newsigpolicyhash-property-secureblackbox_officesigner-class) | The signature policy hash value. |
| [NewSigPolicyHashAlgorithm](#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. |
| [NewSigPolicyID](#newsigpolicyid-property-secureblackbox_officesigner-class) | The policy ID that was included or to be included into the signature. |
| [NewSigPolicyURI](#newsigpolicyuri-property-secureblackbox_officesigner-class) | The signature policy URI that was included in the signature. |
| [NewSigSerialNumber](#newsigserialnumber-property-secureblackbox_officesigner-class) | The serial number of the signing certificate. |
| [NewSigSignatureBytes](#newsigsignaturebytes-property-secureblackbox_officesigner-class) | Returns the binary representation of the Office signature. |
| [NewSigSignatureInfoComments](#newsigsignatureinfocomments-property-secureblackbox_officesigner-class) | Contains the comments for the SignatureInfoText. |
| [NewSigSignatureInfoText](#newsigsignatureinfotext-property-secureblackbox_officesigner-class) | Contains the text of the signature info. |
| [NewSigSignatureOriginSigned](#newsigsignatureoriginsigned-property-secureblackbox_officesigner-class) | Returns True if the signature origin is signed. |
| [NewSigSignatureType](#newsigsignaturetype-property-secureblackbox_officesigner-class) | Specifies the type of this signature. |
| [NewSigSignatureValidationResult](#newsigsignaturevalidationresult-property-secureblackbox_officesigner-class) | The outcome of the cryptographic signature validation. |
| [NewSigSubjectKeyID](#newsigsubjectkeyid-property-secureblackbox_officesigner-class) | Contains the subject key identifier of the signing certificate. |
| [NewSigSubjectRDN](#newsigsubjectrdn-property-secureblackbox_officesigner-class) | Contains information about the person owning the signing certificate. |
| [NewSigTimestamped](#newsigtimestamped-property-secureblackbox_officesigner-class) | Use this property to establish whether the signature contains an embedded timestamp. |
| [NewSigValidatedSigningTime](#newsigvalidatedsigningtime-property-secureblackbox_officesigner-class) | Contains the certified signing time. |
| [NewSigValidationLog](#newsigvalidationlog-property-secureblackbox_officesigner-class) | Contains the complete log of the certificate validation routine. |
| [NewSigXAdESVersion](#newsigxadesversion-property-secureblackbox_officesigner-class) | Specifies XAdES version. |
| [OCSPCount](#ocspcount-property-secureblackbox_officesigner-class) | The number of records in the OCSP arrays. |
| [OCSPBytes](#ocspbytes-property-secureblackbox_officesigner-class) | A buffer containing the raw OCSP response data. |
| [OCSPEntryCount](#ocspentrycount-property-secureblackbox_officesigner-class) | The number of SingleResponse elements contained in this OCSP response. |
| [OCSPHandle](#ocsphandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [OCSPIssuer](#ocspissuer-property-secureblackbox_officesigner-class) | Indicates the issuer of this response (a CA or its authorized representative). |
| [OCSPIssuerRDN](#ocspissuerrdn-property-secureblackbox_officesigner-class) | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| [OCSPLocation](#ocsplocation-property-secureblackbox_officesigner-class) | The location of the OCSP responder. |
| [OCSPProducedAt](#ocspproducedat-property-secureblackbox_officesigner-class) | Specifies the time when the response was produced, in UTC. |
| [OCSPSigAlgorithm](#ocspsigalgorithm-property-secureblackbox_officesigner-class) | The public key algorithm that was used by the CA to sign this OCSP response. |
| [OCSPSource](#ocspsource-property-secureblackbox_officesigner-class) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [OfflineMode](#offlinemode-property-secureblackbox_officesigner-class) | Switches the class to offline mode. |
| [OutputBytes](#outputbytes-property-secureblackbox_officesigner-class) | Use this property to read the output the class object has produced. |
| [OutputFile](#outputfile-property-secureblackbox_officesigner-class) | Defines where to save the signed document. |
| [Profile](#profile-property-secureblackbox_officesigner-class) | Specifies a pre-defined profile to apply when creating the signature. |
| [ProxyAddress](#proxyaddress-property-secureblackbox_officesigner-class) | The IP address of the proxy server. |
| [ProxyAuthentication](#proxyauthentication-property-secureblackbox_officesigner-class) | The authentication type used by the proxy server. |
| [ProxyPassword](#proxypassword-property-secureblackbox_officesigner-class) | The password to authenticate to the proxy server. |
| [ProxyPort](#proxyport-property-secureblackbox_officesigner-class) | The port on the proxy server to connect to. |
| [ProxyType](#proxytype-property-secureblackbox_officesigner-class) | The type of the proxy server. |
| [ProxyRequestHeaders](#proxyrequestheaders-property-secureblackbox_officesigner-class) | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| [ProxyResponseBody](#proxyresponsebody-property-secureblackbox_officesigner-class) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| [ProxyResponseHeaders](#proxyresponseheaders-property-secureblackbox_officesigner-class) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| [ProxyUseIPv6](#proxyuseipv6-property-secureblackbox_officesigner-class) | Specifies whether IPv6 should be used when connecting through the proxy. |
| [ProxyUsername](#proxyusername-property-secureblackbox_officesigner-class) | Specifies the username credential for proxy authentication. |
| [RevocationCheck](#revocationcheck-property-secureblackbox_officesigner-class) | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) | The number of records in the Signature arrays. |
| [SignatureChainValidationDetails](#signaturechainvalidationdetails-property-secureblackbox_officesigner-class) | The details of a certificate chain validation outcome. |
| [SignatureChainValidationResult](#signaturechainvalidationresult-property-secureblackbox_officesigner-class) | The outcome of a certificate chain validation routine. |
| [SignatureClaimedSigningTime](#signatureclaimedsigningtime-property-secureblackbox_officesigner-class) | The signing time from the signer's computer. |
| [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-secureblackbox_officesigner-class) | Returns compatibility errors encountered during validation. |
| [SignatureContainsLongTermInfo](#signaturecontainslongterminfo-property-secureblackbox_officesigner-class) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| [SignatureCorePropertiesSigned](#signaturecorepropertiessigned-property-secureblackbox_officesigner-class) | Returns True if this signature covers the core properties of the document. |
| [SignatureDocumentSigned](#signaturedocumentsigned-property-secureblackbox_officesigner-class) | Returns True if the signature covers the document itself. |
| [SignatureEntityLabel](#signatureentitylabel-property-secureblackbox_officesigner-class) | Use this property to get the signature entity label. |
| [SignatureExpireTime](#signatureexpiretime-property-secureblackbox_officesigner-class) | Specifies the signature expiration time in UTC. |
| [SignatureHandle](#signaturehandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SignatureHashAlgorithm](#signaturehashalgorithm-property-secureblackbox_officesigner-class) | The hash algorithm used for signing. |
| [SignatureIssuerRDN](#signatureissuerrdn-property-secureblackbox_officesigner-class) | The Relative Distinguished Name of the signing certificate's issuer. |
| [SignatureLastArchivalTime](#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. |
| [SignatureLevel](#signaturelevel-property-secureblackbox_officesigner-class) | Specifies which level or form of XAdES should be produced. |
| [SignaturePolicyHash](#signaturepolicyhash-property-secureblackbox_officesigner-class) | The signature policy hash value. |
| [SignaturePolicyHashAlgorithm](#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. |
| [SignaturePolicyID](#signaturepolicyid-property-secureblackbox_officesigner-class) | The policy ID that was included or to be included into the signature. |
| [SignaturePolicyURI](#signaturepolicyuri-property-secureblackbox_officesigner-class) | The signature policy URI that was included in the signature. |
| [SignatureSerialNumber](#signatureserialnumber-property-secureblackbox_officesigner-class) | The serial number of the signing certificate. |
| [SignatureBytes](#signaturebytes-property-secureblackbox_officesigner-class) | Returns the binary representation of the Office signature. |
| [SignatureInfoComments](#signatureinfocomments-property-secureblackbox_officesigner-class) | Contains the comments for the SignatureInfoText. |
| [SignatureInfoText](#signatureinfotext-property-secureblackbox_officesigner-class) | Contains the text of the signature info. |
| [SignatureOriginSigned](#signatureoriginsigned-property-secureblackbox_officesigner-class) | Returns True if the signature origin is signed. |
| [SignatureType](#signaturetype-property-secureblackbox_officesigner-class) | Specifies the type of this signature. |
| [SignatureValidationResult](#signaturevalidationresult-property-secureblackbox_officesigner-class) | The outcome of the cryptographic signature validation. |
| [SignatureSubjectKeyID](#signaturesubjectkeyid-property-secureblackbox_officesigner-class) | Contains the subject key identifier of the signing certificate. |
| [SignatureSubjectRDN](#signaturesubjectrdn-property-secureblackbox_officesigner-class) | Contains information about the person owning the signing certificate. |
| [SignatureTimestamped](#signaturetimestamped-property-secureblackbox_officesigner-class) | Use this property to establish whether the signature contains an embedded timestamp. |
| [SignatureValidatedSigningTime](#signaturevalidatedsigningtime-property-secureblackbox_officesigner-class) | Contains the certified signing time. |
| [SignatureValidationLog](#signaturevalidationlog-property-secureblackbox_officesigner-class) | Contains the complete log of the certificate validation routine. |
| [SignatureXAdESVersion](#signaturexadesversion-property-secureblackbox_officesigner-class) | Specifies XAdES version. |
| [SignedPartCount](#signedpartcount-property-secureblackbox_officesigner-class) | The number of records in the SignedPart arrays. |
| [SignedPartContentType](#signedpartcontenttype-property-secureblackbox_officesigner-class) | Specifies the content type of this signed part. |
| [SignedPartHashAlgorithm](#signedparthashalgorithm-property-secureblackbox_officesigner-class) | The hash algorithm used for signing. |
| [SignedPartIsRelationshipPart](#signedpartisrelationshippart-property-secureblackbox_officesigner-class) | Specifies whether this signed part is a relationship part. |
| [SignedPartPath](#signedpartpath-property-secureblackbox_officesigner-class) | The path to this signed part in the document package. |
| [SignedPartValidationResult](#signedpartvalidationresult-property-secureblackbox_officesigner-class) | The outcome of the cryptographic signature validation. |
| [SigningCertBytes](#signingcertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [SigningCertHandle](#signingcerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SigningChainCount](#signingchaincount-property-secureblackbox_officesigner-class) | The number of records in the SigningChain arrays. |
| [SigningChainBytes](#signingchainbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [SigningChainHandle](#signingchainhandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SocketDNSMode](#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. |
| [SocketDNSPort](#socketdnsport-property-secureblackbox_officesigner-class) | Specifies the port number to be used for sending queries to the DNS server. |
| [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-secureblackbox_officesigner-class) | The timeout (in milliseconds) for each DNS query. |
| [SocketDNSServers](#socketdnsservers-property-secureblackbox_officesigner-class) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-secureblackbox_officesigner-class) | The timeout (in milliseconds) for the whole resolution process. |
| [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-secureblackbox_officesigner-class) | The maximum number of bytes to read from the socket, per second. |
| [SocketLocalAddress](#socketlocaladdress-property-secureblackbox_officesigner-class) | The local network interface to bind the socket to. |
| [SocketLocalPort](#socketlocalport-property-secureblackbox_officesigner-class) | The local port number to bind the socket to. |
| [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-secureblackbox_officesigner-class) | The maximum number of bytes to write to the socket, per second. |
| [SocketTimeout](#sockettimeout-property-secureblackbox_officesigner-class) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| [SocketUseIPv6](#socketuseipv6-property-secureblackbox_officesigner-class) | Enables or disables IP protocol version 6. |
| [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) | The number of records in the Timestamp arrays. |
| [TimestampAccuracy](#timestampaccuracy-property-secureblackbox_officesigner-class) | This property indicates the accuracy of the included time mark, in microseconds. |
| [TimestampBytes](#timestampbytes-property-secureblackbox_officesigner-class) | Returns the raw timestamp data in DER format. |
| [TimestampCertificateIndex](#timestampcertificateindex-property-secureblackbox_officesigner-class) | Returns the index of the TSA certificate in the Certificates collection. |
| [TimestampChainValidationDetails](#timestampchainvalidationdetails-property-secureblackbox_officesigner-class) | The details of a certificate chain validation outcome. |
| [TimestampChainValidationResult](#timestampchainvalidationresult-property-secureblackbox_officesigner-class) | The outcome of a certificate chain validation routine. |
| [TimestampContainsLongTermInfo](#timestampcontainslongterminfo-property-secureblackbox_officesigner-class) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| [TimestampEntityLabel](#timestampentitylabel-property-secureblackbox_officesigner-class) | Use this property to get the timestamp entity label. |
| [TimestampHashAlgorithm](#timestamphashalgorithm-property-secureblackbox_officesigner-class) | Returns the timestamp's hash algorithm. |
| [TimestampParentEntity](#timestampparententity-property-secureblackbox_officesigner-class) | Use this property to get the label of the timestamp's parent entity. |
| [TimestampSerialNumber](#timestampserialnumber-property-secureblackbox_officesigner-class) | Returns the timestamp's serial number. |
| [TimestampTime](#timestamptime-property-secureblackbox_officesigner-class) | The time point incorporated into the timestamp. |
| [TimestampType](#timestamptype-property-secureblackbox_officesigner-class) | Returns the type of the timestamp. |
| [TimestampTSAName](#timestamptsaname-property-secureblackbox_officesigner-class) | This value uniquely identifies the Timestamp Authority (TSA). |
| [TimestampValidationLog](#timestampvalidationlog-property-secureblackbox_officesigner-class) | Contains the TSA certificate chain validation log. |
| [TimestampValidationResult](#timestampvalidationresult-property-secureblackbox_officesigner-class) | Contains the timestamp validation outcome. |
| [TimestampServer](#timestampserver-property-secureblackbox_officesigner-class) | The address of the timestamping server. |
| [TLSClientCertCount](#tlsclientcertcount-property-secureblackbox_officesigner-class) | The number of records in the TLSClientCert arrays. |
| [TLSClientCertBytes](#tlsclientcertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [TLSClientCertHandle](#tlsclientcerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) | The number of records in the TLSServerCert arrays. |
| [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [TLSServerCertFingerprint](#tlsservercertfingerprint-property-secureblackbox_officesigner-class) | Contains the fingerprint (a hash imprint) of this certificate. |
| [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [TLSServerCertIssuer](#tlsservercertissuer-property-secureblackbox_officesigner-class) | The common name of the certificate issuer (CA), typically a company name. |
| [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-secureblackbox_officesigner-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-secureblackbox_officesigner-class) | Specifies the public key algorithm of this certificate. |
| [TLSServerCertKeyBits](#tlsservercertkeybits-property-secureblackbox_officesigner-class) | Returns the length of the public key in bits. |
| [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-secureblackbox_officesigner-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-secureblackbox_officesigner-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-secureblackbox_officesigner-class) | Returns the certificate's serial number. |
| [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-secureblackbox_officesigner-class) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [TLSServerCertSubject](#tlsservercertsubject-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. |
| [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-secureblackbox_officesigner-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-secureblackbox_officesigner-class) | The time point at which the certificate becomes valid, in UTC. |
| [TLSServerCertValidTo](#tlsservercertvalidto-property-secureblackbox_officesigner-class) | The time point at which the certificate expires, in UTC. |
| [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-secureblackbox_officesigner-class) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_officesigner-class) | Selects the base configuration for the TLS settings. |
| [TLSCiphersuites](#tlsciphersuites-property-secureblackbox_officesigner-class) | A list of ciphersuites separated with commas or semicolons. |
| [TLSClientAuth](#tlsclientauth-property-secureblackbox_officesigner-class) | Enables or disables certificate-based client authentication. |
| [TLSExtensions](#tlsextensions-property-secureblackbox_officesigner-class) | Provides access to TLS extensions. |
| [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-secureblackbox_officesigner-class) | Whether to force TLS session resumption when the destination address changes. |
| [TLSGroups](#tlsgroups-property-secureblackbox_officesigner-class) | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| [TLSPreSharedIdentity](#tlspresharedidentity-property-secureblackbox_officesigner-class) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| [TLSPreSharedKey](#tlspresharedkey-property-secureblackbox_officesigner-class) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-secureblackbox_officesigner-class) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-secureblackbox_officesigner-class) | Selects the renegotiation attack prevention mechanism. |
| [TLSRevocationCheck](#tlsrevocationcheck-property-secureblackbox_officesigner-class) | Specifies the kind(s) of revocation check to perform. |
| [TLSSSLOptions](#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. |
| [TLSMode](#tlsmode-property-secureblackbox_officesigner-class) | Specifies the TLS mode to use. |
| [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-secureblackbox_officesigner-class) | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| [TLSUseSessionResumption](#tlsusesessionresumption-property-secureblackbox_officesigner-class) | Enables or disables the TLS session resumption capability. |
| [TLSVersions](#tlsversions-property-secureblackbox_officesigner-class) | The SSL/TLS versions to enable by default. |
| [TrustedCertCount](#trustedcertcount-property-secureblackbox_officesigner-class) | The number of records in the TrustedCert arrays. |
| [TrustedCertBytes](#trustedcertbytes-property-secureblackbox_officesigner-class) | Returns the raw certificate data in DER format. |
| [TrustedCertHandle](#trustedcerthandle-property-secureblackbox_officesigner-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [ValidationMoment](#validationmoment-property-secureblackbox_officesigner-class) | The time point at which signature validity is to be established. |

## Method List

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

|  |  |
| --- | --- |
| [Close](#close-method-secureblackbox_officesigner-class) | Closes an opened document. |
| [Config](#config-method-secureblackbox_officesigner-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-secureblackbox_officesigner-class) | Performs an additional action. |
| [ExtractAsyncData](#extractasyncdata-method-secureblackbox_officesigner-class) | Extracts user data from the DC signing service response. |
| [Open](#open-method-secureblackbox_officesigner-class) | Opens a document for signing or updating. |
| [Reset](#reset-method-secureblackbox_officesigner-class) | Resets the class settings. |
| [Revalidate](#revalidate-method-secureblackbox_officesigner-class) | Revalidates a signature in accordance with current settings. |
| [SelectInfo](#selectinfo-method-secureblackbox_officesigner-class) | Select signature information for a specific entity. |
| [Sign](#sign-method-secureblackbox_officesigner-class) | Calculates the signature value. |
| [SignAsyncBegin](#signasyncbegin-method-secureblackbox_officesigner-class) | Initiates the asynchronous signing operation. |
| [SignAsyncEnd](#signasyncend-method-secureblackbox_officesigner-class) | Completes the asynchronous signing operation. |
| [SignExternal](#signexternal-method-secureblackbox_officesigner-class) | Signs the document using an external signing facility. |
| [Timestamp](#timestamp-method-secureblackbox_officesigner-class) | Use this method to add an timestamp. |
| [Upgrade](#upgrade-method-secureblackbox_officesigner-class) | Upgrades existing XAdES signature to a new form. |

## 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.*

|  |  |
| --- | --- |
| [ChainElementDownload](#chainelementdownload-event-secureblackbox_officesigner-class) | Fires when there is a need to download a chain element from an online source. |
| [ChainElementNeeded](#chainelementneeded-event-secureblackbox_officesigner-class) | Fires when an element required to validate the chain was not located. |
| [ChainElementStore](#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. |
| [ChainValidated](#chainvalidated-event-secureblackbox_officesigner-class) | Reports the completion of a certificate chain validation. |
| [ChainValidationProgress](#chainvalidationprogress-event-secureblackbox_officesigner-class) | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
| [DocumentLoaded](#documentloaded-event-secureblackbox_officesigner-class) | This event is fired when the document has been loaded into memory. |
| [Error](#error-event-secureblackbox_officesigner-class) | Information about errors during signing. |
| [ExternalSign](#externalsign-event-secureblackbox_officesigner-class) | Handles remote or external signing initiated by the SignExternal method or other source. |
| [Notification](#notification-event-secureblackbox_officesigner-class) | This event notifies the application about an underlying control flow event. |
| [SignatureFound](#signaturefound-event-secureblackbox_officesigner-class) | Signifies the start of signature validation. |
| [SignatureValidated](#signaturevalidated-event-secureblackbox_officesigner-class) | Marks the completion of the signature validation routine. |
| [TimestampFound](#timestampfound-event-secureblackbox_officesigner-class) | Signifies the start of a timestamp validation routine. |
| [TimestampRequest](#timestamprequest-event-secureblackbox_officesigner-class) | Fires when the class is ready to request a timestamp from an external TSA. |
| [TimestampValidated](#timestampvalidated-event-secureblackbox_officesigner-class) | Reports the completion of the timestamp validation routine. |
| [TLSCertNeeded](#tlscertneeded-event-secureblackbox_officesigner-class) | Fires when a remote TLS party requests a client certificate. |
| [TLSCertValidate](#tlscertvalidate-event-secureblackbox_officesigner-class) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| [TLSEstablished](#tlsestablished-event-secureblackbox_officesigner-class) | Fires when a TLS handshake with Host successfully completes. |
| [TLSHandshake](#tlshandshake-event-secureblackbox_officesigner-class) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [TLSShutdown](#tlsshutdown-event-secureblackbox_officesigner-class) | Reports the graceful closure of a TLS connection. |

## Config Settings

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

|  |  |
| --- | --- |
| [AddAllDataObjectsTimestamp](#AddAllDataObjectsTimestamp) | Whether to add all data objects timestamp during signing. |
| [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. |
| [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. |
| [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. |
| [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. |
| [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. |
| [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. |
| [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. |
| [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. |
| [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. |
| [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. |
| [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. |
| [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. |
| [ClaimedRolesXML](#ClaimedRolesXML) | The XML content of the claimed roles. |
| [ClaimedRoleText](#ClaimedRoleText) | The text of the claimed role. |
| [CommitmentTypeIndicationAllSignedDataObjects\[Index\]](#CommitmentTypeIndicationAllSignedDataObjects[Index]) | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| [CommitmentTypeIndicationCount](#CommitmentTypeIndicationCount) | The number of the CommitmentTypeIndication elements. |
| [CommitmentTypeIndicationIdentifier\[Index\]](#CommitmentTypeIndicationIdentifier[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| [CommitmentTypeIndicationIdentifierDescription\[Index\]](#CommitmentTypeIndicationIdentifierDescription[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| [CommitmentTypeIndicationIdentifierDocumentationReferences\[Index\]](#CommitmentTypeIndicationIdentifierDocumentationReferences[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| [CommitmentTypeIndicationIdentifierQualifier\[Index\]](#CommitmentTypeIndicationIdentifierQualifier[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| [CommitmentTypeIndicationObjectReference\[Index\]](#CommitmentTypeIndicationObjectReference[Index]) | Specifies the CommitmentTypeIndication's ObjectReference. |
| [CommitmentTypeIndicationQualifiersXML\[Index\]](#CommitmentTypeIndicationQualifiersXML[Index]) | The XML content of the CommitmentTypeIndication's Qualifiers. |
| [CompressionLevel](#CompressionLevel) | Contains the compression level of the document. |
| [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. |
| [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. |
| [DataObjectFormatCount](#DataObjectFormatCount) | The number of the DataObjectFormat elements. |
| [DataObjectFormatDescription\[Index\]](#DataObjectFormatDescription[Index]) | Specifies the DataObjectFormat's Description. |
| [DataObjectFormatEncoding\[Index\]](#DataObjectFormatEncoding[Index]) | Specifies the DataObjectFormat's Encoding. |
| [DataObjectFormatMimeType\[Index\]](#DataObjectFormatMimeType[Index]) | Specifies the DataObjectFormat's MimeType. |
| [DataObjectFormatObjectIdentifier\[Index\]](#DataObjectFormatObjectIdentifier[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
| [DataObjectFormatObjectIdentifierDescription\[Index\]](#DataObjectFormatObjectIdentifierDescription[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
| [DataObjectFormatObjectIdentifierDocumentationReferences\[Index\]](#DataObjectFormatObjectIdentifierDocumentationReferences[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
| [DataObjectFormatObjectIdentifierQualifier\[Index\]](#DataObjectFormatObjectIdentifierQualifier[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
| [DataObjectFormatObjectReference\[Index\]](#DataObjectFormatObjectReference[Index]) | Specifies the DataObjectFormat's ObjectReference. |
| [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. |
| [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
| [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. |
| [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. |
| [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. |
| [ExclusiveCanonicalizationPrefix](#ExclusiveCanonicalizationPrefix) | Specifies the exclusive canonicalization prefix. |
| [ExpireTime](#ExpireTime) | Signature expiration time in UTC. |
| [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. |
| [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. |
| [HMACKey](#HMACKey) | The key value for HMAC. |
| [HMACOutputLength](#HMACOutputLength) | Sets the length of the HMAC output. |
| [HMACSigningUsed](#HMACSigningUsed) | Whether to use HMAC signing. |
| [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. |
| [IgnoreChainValidationErrors](#IgnoreChainValidationErrors) | Whether to ignore any certificate chain validation issues. |
| [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [IgnoreTimestampFailure](#IgnoreTimestampFailure) | Whether to ignore time-stamping failure during signing. |
| [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. |
| [IncludeKnownRevocationInfoToSignature](#IncludeKnownRevocationInfoToSignature) | Whether to include custom revocation info to the signature. |
| [InclusiveNamespacesPrefixList](#InclusiveNamespacesPrefixList) | Specifies the InclusiveNamespaces PrefixList. |
| [KeyInfoID](#KeyInfoID) | Specifies the ID for KeyInfo element. |
| [KeyName](#KeyName) | Contains information about the key used for signing. |
| [PolicyDescription](#PolicyDescription) | signature policy description. |
| [PolicyExplicitText](#PolicyExplicitText) | The explicit text of the user notice. |
| [PolicyUNNumbers](#PolicyUNNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [PolicyUNOrganization](#PolicyUNOrganization) | The organization part of the NoticeReference qualifier. |
| [ProductionPlace](#ProductionPlace) | Identifies the place of the signature production. |
| [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. |
| [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. |
| [QualifyingPropertiesID](#QualifyingPropertiesID) | Specifies the ID for QualifyingProperties element. |
| [QualifyingPropertiesObjectID](#QualifyingPropertiesObjectID) | Specifies the ID for object with QualifyingProperties element. |
| [QualifyingPropertiesReferenceCount](#QualifyingPropertiesReferenceCount) | The number of the QualifyingPropertiesReference elements. |
| [QualifyingPropertiesReferenceID\[Index\]](#QualifyingPropertiesReferenceID[Index]) | Specifies the QualifyingPropertiesReference's ID. |
| [QualifyingPropertiesReferenceURI\[Index\]](#QualifyingPropertiesReferenceURI[Index]) | Specifies the QualifyingPropertiesReference's URI. |
| [RefsTimestampType](#RefsTimestampType) | Specifies references timestamp type to include to the signature. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. |
| [SignatureID](#SignatureID) | Specifies the ID for Signature element. |
| [SignatureInfoAddress1](#SignatureInfoAddress1) | Specifies the location at which the signature was created. |
| [SignatureInfoAddress2](#SignatureInfoAddress2) | Specifies the location at which the signature was created. |
| [SignatureInfoComments](#SignatureInfoComments) | Comments to the signature info text. |
| [SignatureInfoDelegateSuggestedSigner](#SignatureInfoDelegateSuggestedSigner) | Specifies the name of a person. |
| [SignatureInfoDelegateSuggestedSigner2](#SignatureInfoDelegateSuggestedSigner2) | Specifies the title of a person. |
| [SignatureInfoDelegateSuggestedSignerEmail](#SignatureInfoDelegateSuggestedSignerEmail) | Specifies the e-mail address of a person. |
| [SignatureInfoImage](#SignatureInfoImage) | Specifies an image for the digital signature. |
| [SignatureInfoIncluded](#SignatureInfoIncluded) | Whether to include the signature info. |
| [SignatureInfoInvalidLnImage](#SignatureInfoInvalidLnImage) | Specifies the image of an invalid signature. |
| [SignatureInfoSignatureType](#SignatureInfoSignatureType) | Specifies the type of the digital signature. |
| [SignatureInfoText](#SignatureInfoText) | The text to be displayed as the signature info. |
| [SignatureInfoValidLnImage](#SignatureInfoValidLnImage) | Specifies the image of a valid signature. |
| [SignatureLineAdditionalSignatureInfo\[Index\]](#SignatureLineAdditionalSignatureInfo[Index]) | Contains additional signature information. |
| [SignatureLineAllowComments\[Index\]](#SignatureLineAllowComments[Index]) | Indicates if comments are allowed. |
| [SignatureLineCount](#SignatureLineCount) | The number of signature lines. |
| [SignatureLineId\[Index\]](#SignatureLineId[Index]) | Contains signature unique ID. |
| [SignatureLineImageData\[Index\]](#SignatureLineImageData[Index]) | Contains signature image. |
| [SignatureLineIndex](#SignatureLineIndex) | Specifies the index of the signature line to sign. |
| [SignatureLineShowSignDate\[Index\]](#SignatureLineShowSignDate[Index]) | Indicates if signing date should be shown. |
| [SignatureLineSignatureIndex\[Index\]](#SignatureLineSignatureIndex[Index]) | The index of the signature that signs signature line. |
| [SignatureLineSignatureProviderId\[Index\]](#SignatureLineSignatureProviderId[Index]) | Contains signature provider ID. |
| [SignatureLineSignatureProviderUrl\[Index\]](#SignatureLineSignatureProviderUrl[Index]) | Contains signature provider URL. |
| [SignatureLineSigned\[Index\]](#SignatureLineSigned[Index]) | Indicates if signature line is signed. |
| [SignatureLineSigningInstructions\[Index\]](#SignatureLineSigningInstructions[Index]) | Contains signing instructions. |
| [SignatureLineSuggestedSigner2\[Index\]](#SignatureLineSuggestedSigner2[Index]) | Suggested signer line two. |
| [SignatureLineSuggestedSigner\[Index\]](#SignatureLineSuggestedSigner[Index]) | Suggested signer line one. |
| [SignatureLineSuggestedSignerEmail\[Index\]](#SignatureLineSuggestedSignerEmail[Index]) | Suggested signer email address. |
| [SignatureOriginPartURI](#SignatureOriginPartURI) | Contains the signature origin part URI element. |
| [SignaturePartName](#SignaturePartName) | Name of signature part. |
| [SignaturePrefix](#SignaturePrefix) | Specifies the signature prefix. |
| [SignatureValueID](#SignatureValueID) | Specifies the ID for SignatureValue element. |
| [SignedInfoID](#SignedInfoID) | Specifies the ID for SignedInfo element. |
| [SignedPropertiesID](#SignedPropertiesID) | Specifies the ID for SignedProperties element. |
| [SignedPropertiesReferenceCanonicalizationMethod](#SignedPropertiesReferenceCanonicalizationMethod) | Specifies the canonicalization method used in SignedProperties reference. |
| [SignedPropertiesReferenceHashAlgorithm](#SignedPropertiesReferenceHashAlgorithm) | Specifies the hash algorithm used in SignedProperties reference. |
| [SignedPropertiesReferenceID](#SignedPropertiesReferenceID) | Specifies the ID for Reference element that points to SignedProperties element. |
| [SignedPropertiesReferenceInclusiveNamespacesPrefixList](#SignedPropertiesReferenceInclusiveNamespacesPrefixList) | Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference. |
| [SignedPropertiesReferenceIndex](#SignedPropertiesReferenceIndex) | Specifies the index of SignedProperties reference. |
| [SignedSignaturePropertiesID](#SignedSignaturePropertiesID) | Specifies the ID for SignedSignatureProperties element. |
| [SigningCertificatesChain](#SigningCertificatesChain) | Specifies which certificates from SigningChain are included in the xades:SigningCertificate element. |
| [SigningCertificatesHashAlgorithm](#SigningCertificatesHashAlgorithm) | Specifies the hash algorithm used for SigningCertificates. |
| [SigningTimeFormat](#SigningTimeFormat) | Specifies the date time format for the XAdES signing time. |
| [SigningTimeIsUTC](#SigningTimeIsUTC) | Specifies whether the XAdES signing time is in UTC. |
| [SigningTimeZoneOffset](#SigningTimeZoneOffset) | Specifies the time zone offset for the XAdES signing time. |
| [SignTime](#SignTime) | Specifies the signing time in UTC. |
| [SigPolicyDescription](#SigPolicyDescription) | signature policy description. |
| [SigPolicyExplicitText](#SigPolicyExplicitText) | The explicit text of the user notice. |
| [SigPolicyHash](#SigPolicyHash) | The EPES policy hash. |
| [SigPolicyHashAlgorithm](#SigPolicyHashAlgorithm) | The hash algorithm that was used to generate the EPES policy hash. |
| [SigPolicyID](#SigPolicyID) | The EPES policy ID. |
| [SigPolicyNoticeNumbers](#SigPolicyNoticeNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [SigPolicyNoticeOrganization](#SigPolicyNoticeOrganization) | The organization part of the NoticeReference qualifier. |
| [SigPolicyURI](#SigPolicyURI) | The EPES policy URI. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [TimestampCanonicalizationMethod](#TimestampCanonicalizationMethod) | Specifies canonicalization method used in timestamp. |
| [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. |
| [TimestampValidationDataDetails](#TimestampValidationDataDetails) | Specifies timestamp validation data details to include to the signature. |
| [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. |
| [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. |
| [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. |
| [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. |
| [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. |
| [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. |
| [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. |
| [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. |
| [UseDefaultTrustedLists](#UseDefaultTrustedLists) | Enables or disables the use of the default TrustedLists. |
| [UseDefaultTSLs](#UseDefaultTSLs) | Enables or disables the use of the default TrustedLists. |
| [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. |
| [UseHMACSigning](#UseHMACSigning) | Whether to use HMAC signing. |
| [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. |
| [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. |
| [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. |
| [UseValidatorSettingsForTLSValidation](#UseValidatorSettingsForTLSValidation) | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| [ValidationDataRefsDetails](#ValidationDataRefsDetails) | Specifies validation data references details to include to the signature. |
| [ValidationDataRefsHashAlgorithm](#ValidationDataRefsHashAlgorithm) | Specifies the hash algorithm used in validation data references. |
| [ValidationDataValuesDetails](#ValidationDataValuesDetails) | Specifies validation data values details to include to the signature. |
| [XAdESPrefix](#XAdESPrefix) | Specifies the XAdES prefix. |
| [XAdESv141Prefix](#XAdESv141Prefix) | Specifies the XAdES v1.4.1 prefix. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# AutoValidateSignatures Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getAutoValidateSignatures();
public function setAutoValidateSignatures($value);
```

## Procedural Interface

```text
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](#revalidate-method-secureblackbox_officesigner-class) method.

## Data Type

Boolean

# BlockedCertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the BlockedCert arrays.

## Object Oriented Interface

```text
public function getBlockedCertCount();
public function setBlockedCertCount($value);
```

## Procedural Interface

```text
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](#blockedcertbytes-property-secureblackbox_officesigner-class)
- [BlockedCertHandle](#blockedcerthandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getBlockedCertBytes($blockedcertindex);
```

## Procedural Interface

```text
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](#blockedcertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# BlockedCertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getBlockedCertHandle($blockedcertindex);
public function setBlockedCertHandle($blockedcertindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 11 , $blockedcertindex);
secureblackbox_officesigner_set($res, 11, $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.

```text
  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](#blockedcertcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# CertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the Cert arrays.

## Object Oriented Interface

```text
public function getCertCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 42 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CertBytes](#certbytes-property-secureblackbox_officesigner-class)
- [CertCA](#certca-property-secureblackbox_officesigner-class)
- [CertCAKeyID](#certcakeyid-property-secureblackbox_officesigner-class)
- [CertCRLDistributionPoints](#certcrldistributionpoints-property-secureblackbox_officesigner-class)
- [CertCurve](#certcurve-property-secureblackbox_officesigner-class)
- [CertFingerprint](#certfingerprint-property-secureblackbox_officesigner-class)
- [CertFriendlyName](#certfriendlyname-property-secureblackbox_officesigner-class)
- [CertHandle](#certhandle-property-secureblackbox_officesigner-class)
- [CertHashAlgorithm](#certhashalgorithm-property-secureblackbox_officesigner-class)
- [CertIssuer](#certissuer-property-secureblackbox_officesigner-class)
- [CertIssuerRDN](#certissuerrdn-property-secureblackbox_officesigner-class)
- [CertKeyAlgorithm](#certkeyalgorithm-property-secureblackbox_officesigner-class)
- [CertKeyBits](#certkeybits-property-secureblackbox_officesigner-class)
- [CertKeyFingerprint](#certkeyfingerprint-property-secureblackbox_officesigner-class)
- [CertKeyUsage](#certkeyusage-property-secureblackbox_officesigner-class)
- [CertKeyValid](#certkeyvalid-property-secureblackbox_officesigner-class)
- [CertOCSPLocations](#certocsplocations-property-secureblackbox_officesigner-class)
- [CertOCSPNoCheck](#certocspnocheck-property-secureblackbox_officesigner-class)
- [CertOrigin](#certorigin-property-secureblackbox_officesigner-class)
- [CertPolicyIDs](#certpolicyids-property-secureblackbox_officesigner-class)
- [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_officesigner-class)
- [CertPrivateKeyExists](#certprivatekeyexists-property-secureblackbox_officesigner-class)
- [CertPrivateKeyExtractable](#certprivatekeyextractable-property-secureblackbox_officesigner-class)
- [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_officesigner-class)
- [CertQualified](#certqualified-property-secureblackbox_officesigner-class)
- [CertQualifiedStatements](#certqualifiedstatements-property-secureblackbox_officesigner-class)
- [CertQualifiers](#certqualifiers-property-secureblackbox_officesigner-class)
- [CertSelfSigned](#certselfsigned-property-secureblackbox_officesigner-class)
- [CertSerialNumber](#certserialnumber-property-secureblackbox_officesigner-class)
- [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_officesigner-class)
- [CertSource](#certsource-property-secureblackbox_officesigner-class)
- [CertSubject](#certsubject-property-secureblackbox_officesigner-class)
- [CertSubjectAlternativeName](#certsubjectalternativename-property-secureblackbox_officesigner-class)
- [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_officesigner-class)
- [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_officesigner-class)
- [CertType](#certtype-property-secureblackbox_officesigner-class)
- [CertValid](#certvalid-property-secureblackbox_officesigner-class)
- [CertValidFrom](#certvalidfrom-property-secureblackbox_officesigner-class)
- [CertValidTo](#certvalidto-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getCertBytes($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 43 , $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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertCA Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Indicates whether the certificate has a CA capability.

## Object Oriented Interface

```text
public function getCertCA($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 44 , $certindex);
```

## Default Value

false

## Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertCAKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertCAKeyID($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 45 , $certindex);
```

## Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_officesigner-class) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the type of the entity contained in the Certificate object.

## Object Oriented Interface

```text
public function getCertType($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 46 , $certindex);
```

## Possible Values

```text
OFFICESIGNER_CERTTYPE_UNKNOWN(0), OFFICESIGNER_CERTTYPE_X509CERTIFICATE(1), OFFICESIGNER_CERTTYPE_X509CERTIFICATE_REQUEST(2)
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertCRLDistributionPoints Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

## Object Oriented Interface

```text
public function getCertCRLDistributionPoints($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 47 , $certindex);
```

## Default Value

''

## Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertCurve Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the elliptic curve associated with the certificate's public key.

## Object Oriented Interface

```text
public function getCertCurve($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 48 , $certindex);
```

## Default Value

''

## Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertFingerprint Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertFingerprint($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 49 , $certindex);
```

## Default Value

''

## Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertFriendlyName Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertFriendlyName($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 50 , $certindex);
```

## Default Value

''

## Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertHandle($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 51 , $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.

```text
  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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# CertHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

## Object Oriented Interface

```text
public function getCertHashAlgorithm($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 52 , $certindex);
```

## Default Value

''

## Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_officesigner-class) to find out the hash algorithm that is part of the certificate signature.

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertIssuer Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertIssuer($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 53 , $certindex);
```

## Default Value

''

## Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [CertIssuerRDN](#certissuerrdn-property-secureblackbox_officesigner-class).

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

## Object Oriented Interface

```text
public function getCertIssuerRDN($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 54 , $certindex);
```

## Default Value

''

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertKeyAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the public key algorithm of this certificate.

## Object Oriented Interface

```text
public function getCertKeyAlgorithm($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 55 , $certindex);
```

## Default Value

'0'

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [CertKeyBits](#certkeybits-property-secureblackbox_officesigner-class), [CertCurve](#certcurve-property-secureblackbox_officesigner-class), and [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_officesigner-class) properties to get more details about the key the certificate contains.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertKeyBits Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the length of the public key in bits.

## Object Oriented Interface

```text
public function getCertKeyBits($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 56 , $certindex);
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_officesigner-class) or [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_officesigner-class) property would typically contain auxiliary values, and therefore be longer.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertKeyFingerprint Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertKeyFingerprint($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 57 , $certindex);
```

## Default Value

''

## Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the [CertFingerprint](#certfingerprint-property-secureblackbox_officesigner-class) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertKeyUsage Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertKeyUsage($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 58 , $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:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertKeyValid Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertKeyValid($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 59 , $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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertOCSPLocations Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

## Object Oriented Interface

```text
public function getCertOCSPLocations($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 60 , $certindex);
```

## Default Value

''

## Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's [Generate](#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertOCSPNoCheck Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Accessor to the value of the certificate's ocsp-no-check extension.

## Object Oriented Interface

```text
public function getCertOCSPNoCheck($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 61 , $certindex);
```

## Default Value

false

## Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertOrigin Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the location that the certificate was taken or loaded from.

## Object Oriented Interface

```text
public function getCertOrigin($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 62 , $certindex);
```

## Default Value

0

## Remarks

Returns the location that the certificate was taken or loaded from.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertPolicyIDs Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains identifiers (OIDs) of the applicable certificate policies.

## Object Oriented Interface

```text
public function getCertPolicyIDs($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 63 , $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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertPrivateKeyBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the certificate's private key in DER-encoded format.

## Object Oriented Interface

```text
public function getCertPrivateKeyBytes($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 64 , $certindex);
```

## Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertPrivateKeyExists Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Indicates whether the certificate has a usable private key associated with it.

## Object Oriented Interface

```text
public function getCertPrivateKeyExists($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 65 , $certindex);
```

## Default Value

false

## Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_officesigner-class), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertPrivateKeyExtractable Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Indicates whether the private key is extractable (exportable).

## Object Oriented Interface

```text
public function getCertPrivateKeyExtractable($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 66 , $certindex);
```

## Default Value

false

## Remarks

Indicates whether the private key is extractable (exportable).

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertPublicKeyBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the certificate's public key in DER format.

## Object Oriented Interface

```text
public function getCertPublicKeyBytes($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 67 , $certindex);
```

## Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertQualified Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Indicates whether the certificate is qualified.

## Object Oriented Interface

```text
public function getCertQualified($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 68 , $certindex);
```

## Default Value

false

## Remarks

Indicates whether the certificate is qualified.

This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertQualifiedStatements Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns a simplified qualified status of the certificate.

## Object Oriented Interface

```text
public function getCertQualifiedStatements($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 69 , $certindex);
```

## Possible Values

```text
OFFICESIGNER_CERTQUALIFIEDSTATEMENTS_NON_QUALIFIED(0), OFFICESIGNER_CERTQUALIFIEDSTATEMENTS_QUALIFIED_HARDWARE(1), OFFICESIGNER_CERTQUALIFIEDSTATEMENTS_QUALIFIED_SOFTWARE(2)
```

## Default Value

0

## Remarks

Returns a simplified qualified status 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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertQualifiers Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of qualifiers.

## Object Oriented Interface

```text
public function getCertQualifiers($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 70 , $certindex);
```

## Default Value

''

## Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertSelfSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertSelfSigned($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 71 , $certindex);
```

## Default Value

false

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertSerialNumber Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the certificate's serial number.

## Object Oriented Interface

```text
public function getCertSerialNumber($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 72 , $certindex);
```

## Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertSigAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertSigAlgorithm($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 73 , $certindex);
```

## Default Value

''

## Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertSource Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

## Object Oriented Interface

```text
public function getCertSource($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 74 , $certindex);
```

## Possible Values

```text
OFFICESIGNER_CERTSOURCE_UNKNOWN(0), OFFICESIGNER_CERTSOURCE_SIGNATURE(1), OFFICESIGNER_CERTSOURCE_DOCUMENT(2), OFFICESIGNER_CERTSOURCE_USER(3), OFFICESIGNER_CERTSOURCE_LOCAL(4), OFFICESIGNER_CERTSOURCE_ONLINE(5)
```

## Default Value

0

## Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CertSubject Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getCertSubject($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 75 , $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. This is part of a larger set of credentials available via [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_officesigner-class).

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertSubjectAlternativeName Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

## Object Oriented Interface

```text
public function getCertSubjectAlternativeName($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 76 , $certindex);
```

## Default Value

''

## Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_officesigner-class) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertSubjectKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains a unique identifier of the certificate's cryptographic key.

## Object Oriented Interface

```text
public function getCertSubjectKeyID($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 77 , $certindex);
```

## Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_officesigner-class) and [CertCAKeyID](#certcakeyid-property-secureblackbox_officesigner-class) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CertSubjectRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

## Object Oriented Interface

```text
public function getCertSubjectRDN($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 78 , $certindex);
```

## Default Value

''

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertValid Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

## Object Oriented Interface

```text
public function getCertValid($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 79 , $certindex);
```

## Default Value

false

## Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# CertValidFrom Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertValidFrom($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 80 , $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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CertValidTo Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCertValidTo($certindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 81 , $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](#certcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CheckTrustedLists Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

## Object Oriented Interface

```text
public function getCheckTrustedLists();
public function setCheckTrustedLists($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 82 );
secureblackbox_officesigner_set($res, 82, $value );
```

## Default Value

false

## Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

## Data Type

Boolean

# CRLCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the CRL arrays.

## Object Oriented Interface

```text
public function getCRLCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 83 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CRLBytes](#crlbytes-property-secureblackbox_officesigner-class)
- [CRLCAKeyID](#crlcakeyid-property-secureblackbox_officesigner-class)
- [CRLEntryCount](#crlentrycount-property-secureblackbox_officesigner-class)
- [CRLHandle](#crlhandle-property-secureblackbox_officesigner-class)
- [CRLIssuer](#crlissuer-property-secureblackbox_officesigner-class)
- [CRLIssuerRDN](#crlissuerrdn-property-secureblackbox_officesigner-class)
- [CRLLocation](#crllocation-property-secureblackbox_officesigner-class)
- [CRLNextUpdate](#crlnextupdate-property-secureblackbox_officesigner-class)
- [CRLSigAlgorithm](#crlsigalgorithm-property-secureblackbox_officesigner-class)
- [CRLSource](#crlsource-property-secureblackbox_officesigner-class)
- [CRLTBS](#crltbs-property-secureblackbox_officesigner-class)
- [CRLThisUpdate](#crlthisupdate-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw CRL data in DER format.

## Object Oriented Interface

```text
public function getCRLBytes($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 84 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CRLCAKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

## Object Oriented Interface

```text
public function getCRLCAKeyID($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 85 , $crlindex);
```

## Remarks

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

The *$crlindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CRLEntryCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the number of certificate status entries in the CRL.

## Object Oriented Interface

```text
public function getCRLEntryCount($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 86 , $crlindex);
```

## Default Value

0

## Remarks

Returns the number of certificate status entries in the CRL.

The *$crlindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CRLHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCRLHandle($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 87 , $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.

```text
  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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# CRLIssuer Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCRLIssuer($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 88 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CRLIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCRLIssuerRDN($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 89 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CRLLocation Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The URL that the CRL was downloaded from.

## Object Oriented Interface

```text
public function getCRLLocation($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 90 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CRLNextUpdate Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCRLNextUpdate($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 91 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CRLSigAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The public key algorithm that was used by the CA to sign this CRL.

## Object Oriented Interface

```text
public function getCRLSigAlgorithm($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 92 , $crlindex);
```

## Default Value

'0'

## Remarks

The public key algorithm that was used by the CA to sign this CRL.

The *$crlindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# CRLSource Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

## Object Oriented Interface

```text
public function getCRLSource($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 93 , $crlindex);
```

## Possible Values

```text
OFFICESIGNER_CRLSOURCE_UNKNOWN(0), OFFICESIGNER_CRLSOURCE_SIGNATURE(1), OFFICESIGNER_CRLSOURCE_DOCUMENT(2), OFFICESIGNER_CRLSOURCE_USER(3), OFFICESIGNER_CRLSOURCE_LOCAL(4), OFFICESIGNER_CRLSOURCE_ONLINE(5)
```

## Default Value

0

## Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The *$crlindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# CRLTBS Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The to-be-signed part of the CRL (the CRL without the signature part).

## Object Oriented Interface

```text
public function getCRLTBS($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 94 , $crlindex);
```

## Remarks

The to-be-signed part of the CRL (the CRL without the signature part).

The *$crlindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# CRLThisUpdate Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getCRLThisUpdate($crlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 95 , $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](#crlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# DocumentFormat Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Defines the format of the Office document.

## Object Oriented Interface

```text
public function getDocumentFormat();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 96 );
```

## Possible Values

```text
OFFICESIGNER_DOCUMENTFORMAT_UNKNOWN(0), OFFICESIGNER_DOCUMENTFORMAT_BINARY(1), OFFICESIGNER_DOCUMENTFORMAT_OPEN_XML(2), OFFICESIGNER_DOCUMENTFORMAT_OPEN_XPS(3), OFFICESIGNER_DOCUMENTFORMAT_OPEN_DOCUMENT(4)
```

## Default Value

0

## Remarks

This property contains the Office document format.

|  |  |  |
| --- | --- | --- |
| odfUnknown | 0 | Unknown document format |
| odfBinary | 1 | Binary Office document |
| odfOpenXML | 2 | OpenXML Office document |
| odfOpenXPS | 3 | OpenXPS document |
| odfOpenDocument | 4 | OpenOffice document |

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

## Data Type

Integer

# DocumentType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Defines the type of the Office document.

## Object Oriented Interface

```text
public function getDocumentType();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 97 );
```

## 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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 98 );
secureblackbox_officesigner_set($res, 98, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 99 );
secureblackbox_officesigner_set($res, 99, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoData();
public function setExternalCryptoData($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 100 );
secureblackbox_officesigner_set($res, 100, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoExternalHashCalculation();
public function setExternalCryptoExternalHashCalculation($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 101 );
secureblackbox_officesigner_set($res, 101, $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](#officesigner-class) Class)

Specifies the request's signature hash algorithm.

## Object Oriented Interface

```text
public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 102 );
secureblackbox_officesigner_set($res, 102, $value );
```

## Default Value

'SHA256'

## Remarks

Specifies the request's signature hash algorithm.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

## Data Type

String

# ExternalCryptoKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoKeyID();
public function setExternalCryptoKeyID($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 103 );
secureblackbox_officesigner_set($res, 103, $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](#externalcryptokeysecret-property-secureblackbox_officesigner-class) 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:

```text
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";
```

## Data Type

String

# ExternalCryptoKeySecret Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The pre-shared key used for DC request authentication.

## Object Oriented Interface

```text
public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 104 );
secureblackbox_officesigner_set($res, 104, $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](#externalcryptokeyid-property-secureblackbox_officesigner-class) topic.

## Data Type

String

# ExternalCryptoMethod Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the asynchronous signing method.

## Object Oriented Interface

```text
public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 105 );
secureblackbox_officesigner_set($res, 105, $value );
```

## Possible Values

```text
OFFICESIGNER_EXTERNALCRYPTOMETHOD_PKCS1(0), OFFICESIGNER_EXTERNALCRYPTOMETHOD_PKCS7(1)
```

## Default Value

0

## Remarks

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

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

## Data Type

Integer

# ExternalCryptoMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the external cryptography mode.

## Object Oriented Interface

```text
public function getExternalCryptoMode();
public function setExternalCryptoMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 106 );
secureblackbox_officesigner_set($res, 106, $value );
```

## Possible Values

```text
OFFICESIGNER_EXTERNALCRYPTOMODE_DEFAULT(0), OFFICESIGNER_EXTERNALCRYPTOMODE_DISABLED(1), OFFICESIGNER_EXTERNALCRYPTOMODE_GENERIC(2), OFFICESIGNER_EXTERNALCRYPTOMODE_DCAUTH(3), OFFICESIGNER_EXTERNALCRYPTOMODE_DCAUTH_JSON(4)
```

## Default Value

0

## Remarks

Specifies the external cryptography mode.

Available options:

|  |  |
| --- | --- |
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |

This property is not available at design time.

## Data Type

Integer

# ExternalCryptoPublicKeyAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getExternalCryptoPublicKeyAlgorithm();
public function setExternalCryptoPublicKeyAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 107 );
secureblackbox_officesigner_set($res, 107, $value );
```

## Default Value

''

## Remarks

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

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

## Data Type

String

# FIPSMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Reserved.

## Object Oriented Interface

```text
public function getFIPSMode();
public function setFIPSMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 108 );
secureblackbox_officesigner_set($res, 108, $value );
```

## Default Value

false

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# IgnoreChainValidationErrors Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Makes the class tolerant to chain validation errors.

## Object Oriented Interface

```text
public function getIgnoreChainValidationErrors();
public function setIgnoreChainValidationErrors($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 109 );
secureblackbox_officesigner_set($res, 109, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getInputBytes();
public function setInputBytes($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 110 );
secureblackbox_officesigner_set($res, 110, $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](#officesigner-class) Class)

The file to be signed.

## Object Oriented Interface

```text
public function getInputFile();
public function setInputFile($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 111 );
secureblackbox_officesigner_set($res, 111, $value );
```

## Default Value

''

## Remarks

Provide the path to the Office document to be signed.

## Data Type

String

# KnownCertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the KnownCert arrays.

## Object Oriented Interface

```text
public function getKnownCertCount();
public function setKnownCertCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 112 );
secureblackbox_officesigner_set($res, 112, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [KnownCertBytes](#knowncertbytes-property-secureblackbox_officesigner-class)
- [KnownCertHandle](#knowncerthandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getKnownCertBytes($knowncertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 113 , $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](#knowncertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# KnownCertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getKnownCertHandle($knowncertindex);
public function setKnownCertHandle($knowncertindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 121 , $knowncertindex);
secureblackbox_officesigner_set($res, 121, $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.

```text
  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](#knowncertcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# KnownCRLCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the KnownCRL arrays.

## Object Oriented Interface

```text
public function getKnownCRLCount();
public function setKnownCRLCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 152 );
secureblackbox_officesigner_set($res, 152, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [KnownCRLBytes](#knowncrlbytes-property-secureblackbox_officesigner-class)
- [KnownCRLHandle](#knowncrlhandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw CRL data in DER format.

## Object Oriented Interface

```text
public function getKnownCRLBytes($knowncrlindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 153 , $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](#knowncrlcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# KnownCRLHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getKnownCRLHandle($knowncrlindex);
public function setKnownCRLHandle($knowncrlindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 156 , $knowncrlindex);
secureblackbox_officesigner_set($res, 156, $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.

```text
  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](#knowncrlcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# KnownOCSPCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the KnownOCSP arrays.

## Object Oriented Interface

```text
public function getKnownOCSPCount();
public function setKnownOCSPCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 165 );
secureblackbox_officesigner_set($res, 165, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [KnownOCSPBytes](#knownocspbytes-property-secureblackbox_officesigner-class)
- [KnownOCSPHandle](#knownocsphandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

A buffer containing the raw OCSP response data.

## Object Oriented Interface

```text
public function getKnownOCSPBytes($knownocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 166 , $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](#knownocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# KnownOCSPHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getKnownOCSPHandle($knownocspindex);
public function setKnownOCSPHandle($knownocspindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 168 , $knownocspindex);
secureblackbox_officesigner_set($res, 168, $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.

```text
  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](#knownocspcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# NewSigChainValidationDetails Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The details of a certificate chain validation outcome.

## Object Oriented Interface

```text
public function getNewSigChainValidationDetails();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 175 );
```

## Default Value

0

## Remarks

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

Returns a bit mask of the following options:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Integer

# NewSigChainValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of a certificate chain validation routine.

## Object Oriented Interface

```text
public function getNewSigChainValidationResult();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 176 );
```

## Possible Values

```text
OFFICESIGNER_NEWSIGCHAINVALIDATIONRESULT_VALID(0), OFFICESIGNER_NEWSIGCHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(1), OFFICESIGNER_NEWSIGCHAINVALIDATIONRESULT_INVALID(2), OFFICESIGNER_NEWSIGCHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(3)
```

## Default Value

0

## Remarks

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Integer

# NewSigClaimedSigningTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signing time from the signer's computer.

## Object Oriented Interface

```text
public function getNewSigClaimedSigningTime();
public function setNewSigClaimedSigningTime($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 177 );
secureblackbox_officesigner_set($res, 177, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigCompatibilityErrors Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns compatibility errors encountered during validation.

## Object Oriented Interface

```text
public function getNewSigCompatibilityErrors();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 178 );
```

## Default Value

0

## Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Integer

# NewSigContainsLongTermInfo Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

## Object Oriented Interface

```text
public function getNewSigContainsLongTermInfo();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 179 );
```

## Default Value

false

## Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Boolean

# NewSigCorePropertiesSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getNewSigCorePropertiesSigned();
public function setNewSigCorePropertiesSigned($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 180 );
secureblackbox_officesigner_set($res, 180, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Boolean

# NewSigDocumentSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns True if the signature covers the document itself.

## Object Oriented Interface

```text
public function getNewSigDocumentSigned();
public function setNewSigDocumentSigned($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 181 );
secureblackbox_officesigner_set($res, 181, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Boolean

# NewSigEntityLabel Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Use this property to get the signature entity label.

## Object Oriented Interface

```text
public function getNewSigEntityLabel();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 182 );
```

## Default Value

''

## Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigExpireTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the signature expiration time in UTC.

## Object Oriented Interface

```text
public function getNewSigExpireTime();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 183 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getNewSigHandle();
public function setNewSigHandle($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 184 );
secureblackbox_officesigner_set($res, 184, $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.

```text
  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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Long64

# NewSigHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The hash algorithm used for signing.

## Object Oriented Interface

```text
public function getNewSigHashAlgorithm();
public function setNewSigHashAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 185 );
secureblackbox_officesigner_set($res, 185, $value );
```

## Default Value

'Unknown'

## Remarks

The hash algorithm used for signing.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getNewSigIssuerRDN();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 186 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigLastArchivalTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getNewSigLastArchivalTime();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 187 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigLevel Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies which level or form of XAdES should be produced.

## Object Oriented Interface

```text
public function getNewSigLevel();
public function setNewSigLevel($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 188 );
secureblackbox_officesigner_set($res, 188, $value );
```

## Possible Values

```text
OFFICESIGNER_NEWSIGLEVEL_UNKNOWN(0), OFFICESIGNER_NEWSIGLEVEL_GENERIC(1), OFFICESIGNER_NEWSIGLEVEL_BASELINE_B(2), OFFICESIGNER_NEWSIGLEVEL_BASELINE_T(3), OFFICESIGNER_NEWSIGLEVEL_BASELINE_LT(4), OFFICESIGNER_NEWSIGLEVEL_BASELINE_LTA(5), OFFICESIGNER_NEWSIGLEVEL_BES(6), OFFICESIGNER_NEWSIGLEVEL_EPES(7), OFFICESIGNER_NEWSIGLEVEL_T(8), OFFICESIGNER_NEWSIGLEVEL_C(9), OFFICESIGNER_NEWSIGLEVEL_X(10), OFFICESIGNER_NEWSIGLEVEL_XTYPE_1(11), OFFICESIGNER_NEWSIGLEVEL_XTYPE_2(12), OFFICESIGNER_NEWSIGLEVEL_XL(13), OFFICESIGNER_NEWSIGLEVEL_XLTYPE_1(14), OFFICESIGNER_NEWSIGLEVEL_XLTYPE_2(15), OFFICESIGNER_NEWSIGLEVEL_A(16), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_BES(17), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_EPES(18), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_T(19), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_C(20), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_X(21), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XTYPE_1(22), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XTYPE_2(23), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XLONG(24), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XL(25), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XLTYPE_1(26), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_XLTYPE_2(27), OFFICESIGNER_NEWSIGLEVEL_EXTENDED_A(28), OFFICESIGNER_NEWSIGLEVEL_BASELINE_EXTENDED_B(29), OFFICESIGNER_NEWSIGLEVEL_BASELINE_EXTENDED_T(30), OFFICESIGNER_NEWSIGLEVEL_BASELINE_EXTENDED_LT(31), OFFICESIGNER_NEWSIGLEVEL_BASELINE_EXTENDED_LTA(32)
```

## Default Value

6

## Remarks

Specifies which level or form of XAdES should be produced.

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

Use the *Generic* value to produce XML-DSIG signature.

The supported levels and forms are:

|  |  |  |
| --- | --- | --- |
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |

* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2

Note: Microsoft Office supports standard XAdES forms, including BES, EPES, T, X, X-L, A, and Baseline profiles. However, it does not support Extended XAdES forms. Additionally, Microsoft Office versions 2010, 2013, and 2016 do not support the Archive form (*aslA*) or the B-LTA level (*aslBaselineLTA*).

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Integer

# NewSigPolicyHash Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signature policy hash value.

## Object Oriented Interface

```text
public function getNewSigPolicyHash();
public function setNewSigPolicyHash($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 189 );
secureblackbox_officesigner_set($res, 189, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigPolicyHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getNewSigPolicyHashAlgorithm();
public function setNewSigPolicyHashAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 190 );
secureblackbox_officesigner_set($res, 190, $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](#newsigpolicyhash-property-secureblackbox_officesigner-class).

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

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigPolicyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getNewSigPolicyID();
public function setNewSigPolicyID($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 191 );
secureblackbox_officesigner_set($res, 191, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigPolicyURI Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signature policy URI that was included in the signature.

## Object Oriented Interface

```text
public function getNewSigPolicyURI();
public function setNewSigPolicyURI($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 192 );
secureblackbox_officesigner_set($res, 192, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigSerialNumber Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The serial number of the signing certificate.

## Object Oriented Interface

```text
public function getNewSigSerialNumber();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 193 );
```

## Remarks

The serial number of the signing certificate.

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Byte Array

# NewSigSignatureBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the binary representation of the Office signature.

## Object Oriented Interface

```text
public function getNewSigSignatureBytes();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 194 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Byte Array

# NewSigSignatureInfoComments Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the comments for the SignatureInfoText.

## Object Oriented Interface

```text
public function getNewSigSignatureInfoComments();
public function setNewSigSignatureInfoComments($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 195 );
secureblackbox_officesigner_set($res, 195, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigSignatureInfoText Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the text of the signature info.

## Object Oriented Interface

```text
public function getNewSigSignatureInfoText();
public function setNewSigSignatureInfoText($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 196 );
secureblackbox_officesigner_set($res, 196, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

String

# NewSigSignatureOriginSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns True if the signature origin is signed.

## Object Oriented Interface

```text
public function getNewSigSignatureOriginSigned();
public function setNewSigSignatureOriginSigned($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 197 );
secureblackbox_officesigner_set($res, 197, $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](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Boolean

# NewSigSignatureType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the type of this signature.

## Object Oriented Interface

```text
public function getNewSigSignatureType();
public function setNewSigSignatureType($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 198 );
secureblackbox_officesigner_set($res, 198, $value );
```

## Possible Values

```text
OFFICESIGNER_NEWSIGSIGNATURETYPE_DEFAULT(0), OFFICESIGNER_NEWSIGSIGNATURETYPE_BINARY_CRYPTO_API(1), OFFICESIGNER_NEWSIGSIGNATURETYPE_BINARY_XML(2), OFFICESIGNER_NEWSIGSIGNATURETYPE_OPEN_XML(3), OFFICESIGNER_NEWSIGSIGNATURETYPE_OPEN_XPS(4), OFFICESIGNER_NEWSIGSIGNATURETYPE_OPEN_DOCUMENT(5)
```

## Default Value

0

## Remarks

Specifies the type of this signature.

|  |  |  |
| --- | --- | --- |
| ostDefault | 0 |  |
| ostBinaryCryptoAPI | 1 |  |
| ostBinaryXML | 2 |  |
| ostOpenXML | 3 |  |
| ostOpenXPS | 4 |  |
| ostOpenDocument | 5 |  |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Integer

# NewSigSignatureValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of the cryptographic signature validation.

## Object Oriented Interface

```text
public function getNewSigSignatureValidationResult();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 199 );
```

## Possible Values

```text
OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_VALID(0), OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_UNKNOWN(1), OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_CORRUPTED(2), OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_FAILURE(4), OFFICESIGNER_NEWSIGSIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5)
```

## Default Value

0

## Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Integer

# NewSigSubjectKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the subject key identifier of the signing certificate.

## Object Oriented Interface

```text
public function getNewSigSubjectKeyID();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 200 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Byte Array

# NewSigSubjectRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains information about the person owning the signing certificate.

## Object Oriented Interface

```text
public function getNewSigSubjectRDN();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 201 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigTimestamped Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getNewSigTimestamped();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 202 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

Boolean

# NewSigValidatedSigningTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the certified signing time.

## Object Oriented Interface

```text
public function getNewSigValidatedSigningTime();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 203 );
```

## 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](#newsigclaimedsigningtime-property-secureblackbox_officesigner-class) 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigValidationLog Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the complete log of the certificate validation routine.

## Object Oriented Interface

```text
public function getNewSigValidationLog();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 204 );
```

## 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](#OfficeSigner_p_NewSigCount) property.

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

## Data Type

String

# NewSigXAdESVersion Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies XAdES version.

## Object Oriented Interface

```text
public function getNewSigXAdESVersion();
public function setNewSigXAdESVersion($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 205 );
secureblackbox_officesigner_set($res, 205, $value );
```

## Possible Values

```text
OFFICESIGNER_NEWSIGXADESVERSION_UNKNOWN(0), OFFICESIGNER_NEWSIGXADESVERSION_111(1), OFFICESIGNER_NEWSIGXADESVERSION_122(2), OFFICESIGNER_NEWSIGXADESVERSION_132(3), OFFICESIGNER_NEWSIGXADESVERSION_141(4)
```

## Default Value

3

## Remarks

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with.

The supported versions are:

|  |  |  |
| --- | --- | --- |
| xavUnknown | 0 | Unknown |
| xav111 | 1 | XAdES v1.1.1 |
| xav122 | 2 | XAdES v1.2.2 |
| xav132 | 3 | XAdES v1.3.2 |
| xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |

Note: Microsoft Office supports XAdES version 1.3.2 only.

The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#OfficeSigner_p_NewSigCount) property.

This property is not available at design time.

## Data Type

Integer

# OCSPCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the OCSP arrays.

## Object Oriented Interface

```text
public function getOCSPCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 206 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [OCSPBytes](#ocspbytes-property-secureblackbox_officesigner-class)
- [OCSPEntryCount](#ocspentrycount-property-secureblackbox_officesigner-class)
- [OCSPHandle](#ocsphandle-property-secureblackbox_officesigner-class)
- [OCSPIssuer](#ocspissuer-property-secureblackbox_officesigner-class)
- [OCSPIssuerRDN](#ocspissuerrdn-property-secureblackbox_officesigner-class)
- [OCSPLocation](#ocsplocation-property-secureblackbox_officesigner-class)
- [OCSPProducedAt](#ocspproducedat-property-secureblackbox_officesigner-class)
- [OCSPSigAlgorithm](#ocspsigalgorithm-property-secureblackbox_officesigner-class)
- [OCSPSource](#ocspsource-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

A buffer containing the raw OCSP response data.

## Object Oriented Interface

```text
public function getOCSPBytes($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 207 , $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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# OCSPEntryCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of SingleResponse elements contained in this OCSP response.

## Object Oriented Interface

```text
public function getOCSPEntryCount($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 208 , $ocspindex);
```

## Default Value

0

## Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

The *$ocspindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# OCSPHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getOCSPHandle($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 209 , $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.

```text
  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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# OCSPIssuer Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getOCSPIssuer($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 210 , $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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# OCSPIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getOCSPIssuerRDN($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 211 , $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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# OCSPLocation Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The location of the OCSP responder.

## Object Oriented Interface

```text
public function getOCSPLocation($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 212 , $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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# OCSPProducedAt Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getOCSPProducedAt($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 213 , $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](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# OCSPSigAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The public key algorithm that was used by the CA to sign this OCSP response.

## Object Oriented Interface

```text
public function getOCSPSigAlgorithm($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 214 , $ocspindex);
```

## Default Value

'0'

## Remarks

The public key algorithm that was used by the CA to sign this OCSP response.

The *$ocspindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# OCSPSource Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

## Object Oriented Interface

```text
public function getOCSPSource($ocspindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 215 , $ocspindex);
```

## Possible Values

```text
OFFICESIGNER_OCSPSOURCE_UNKNOWN(0), OFFICESIGNER_OCSPSOURCE_SIGNATURE(1), OFFICESIGNER_OCSPSOURCE_DOCUMENT(2), OFFICESIGNER_OCSPSOURCE_USER(3), OFFICESIGNER_OCSPSOURCE_LOCAL(4), OFFICESIGNER_OCSPSOURCE_ONLINE(5)
```

## Default Value

0

## Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The *$ocspindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# OfflineMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Switches the class to offline mode.

## Object Oriented Interface

```text
public function getOfflineMode();
public function setOfflineMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 216 );
secureblackbox_officesigner_set($res, 216, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getOutputBytes();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 217 );
```

## 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](#outputfile-property-secureblackbox_officesigner-class) 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](#officesigner-class) Class)

Defines where to save the signed document.

## Object Oriented Interface

```text
public function getOutputFile();
public function setOutputFile($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 218 );
secureblackbox_officesigner_set($res, 218, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# Profile Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getProfile();
public function setProfile($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 219 );
secureblackbox_officesigner_set($res, 219, $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](#officesigner-class) Class)

The IP address of the proxy server.

## Object Oriented Interface

```text
public function getProxyAddress();
public function setProxyAddress($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 220 );
secureblackbox_officesigner_set($res, 220, $value );
```

## Default Value

''

## Remarks

The IP address of the proxy server.

## Data Type

String

# ProxyAuthentication Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The authentication type used by the proxy server.

## Object Oriented Interface

```text
public function getProxyAuthentication();
public function setProxyAuthentication($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 221 );
secureblackbox_officesigner_set($res, 221, $value );
```

## Possible Values

```text
OFFICESIGNER_PROXYAUTHENTICATION_NO_AUTHENTICATION(0), OFFICESIGNER_PROXYAUTHENTICATION_BASIC(1), OFFICESIGNER_PROXYAUTHENTICATION_DIGEST(2), OFFICESIGNER_PROXYAUTHENTICATION_NTLM(3)
```

## Default Value

0

## Remarks

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

## Data Type

Integer

# ProxyPassword Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The password to authenticate to the proxy server.

## Object Oriented Interface

```text
public function getProxyPassword();
public function setProxyPassword($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 222 );
secureblackbox_officesigner_set($res, 222, $value );
```

## Default Value

''

## Remarks

The password to authenticate to the proxy server.

## Data Type

String

# ProxyPort Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The port on the proxy server to connect to.

## Object Oriented Interface

```text
public function getProxyPort();
public function setProxyPort($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 223 );
secureblackbox_officesigner_set($res, 223, $value );
```

## Default Value

0

## Remarks

The port on the proxy server to connect to.

## Data Type

Integer

# ProxyType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The type of the proxy server.

## Object Oriented Interface

```text
public function getProxyType();
public function setProxyType($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 224 );
secureblackbox_officesigner_set($res, 224, $value );
```

## Possible Values

```text
OFFICESIGNER_PROXYTYPE_NONE(0), OFFICESIGNER_PROXYTYPE_SOCKS_4(1), OFFICESIGNER_PROXYTYPE_SOCKS_5(2), OFFICESIGNER_PROXYTYPE_WEB_TUNNEL(3), OFFICESIGNER_PROXYTYPE_HTTP(4)
```

## Default Value

0

## Remarks

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

## Data Type

Integer

# ProxyRequestHeaders Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Object Oriented Interface

```text
public function getProxyRequestHeaders();
public function setProxyRequestHeaders($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 225 );
secureblackbox_officesigner_set($res, 225, $value );
```

## Default Value

''

## Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Data Type

String

# ProxyResponseBody Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getProxyResponseBody();
public function setProxyResponseBody($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 226 );
secureblackbox_officesigner_set($res, 226, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# ProxyResponseHeaders Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getProxyResponseHeaders();
public function setProxyResponseHeaders($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 227 );
secureblackbox_officesigner_set($res, 227, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# ProxyUseIPv6 Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getProxyUseIPv6();
public function setProxyUseIPv6($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 228 );
secureblackbox_officesigner_set($res, 228, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# ProxyUsername Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the username credential for proxy authentication.

## Object Oriented Interface

```text
public function getProxyUsername();
public function setProxyUsername($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 229 );
secureblackbox_officesigner_set($res, 229, $value );
```

## Default Value

''

## Remarks

Specifies the username credential for proxy authentication.

## Data Type

String

# RevocationCheck Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getRevocationCheck();
public function setRevocationCheck($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 230 );
secureblackbox_officesigner_set($res, 230, $value );
```

## Possible Values

```text
OFFICESIGNER_REVOCATIONCHECK_NONE(0), OFFICESIGNER_REVOCATIONCHECK_AUTO(1), OFFICESIGNER_REVOCATIONCHECK_ALL_CRL(2), OFFICESIGNER_REVOCATIONCHECK_ALL_OCSP(3), OFFICESIGNER_REVOCATIONCHECK_ALL_CRLAND_OCSP(4), OFFICESIGNER_REVOCATIONCHECK_ANY_CRL(5), OFFICESIGNER_REVOCATIONCHECK_ANY_OCSP(6), OFFICESIGNER_REVOCATIONCHECK_ANY_CRLOR_OCSP(7), OFFICESIGNER_REVOCATIONCHECK_ANY_OCSPOR_CRL(8)
```

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

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

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

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

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

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

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

## Data Type

Integer

# SignatureCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the Signature arrays.

## Object Oriented Interface

```text
public function getSignatureCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 231 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SignatureBytes](#signaturebytes-property-secureblackbox_officesigner-class)
- [SignatureChainValidationDetails](#signaturechainvalidationdetails-property-secureblackbox_officesigner-class)
- [SignatureChainValidationResult](#signaturechainvalidationresult-property-secureblackbox_officesigner-class)
- [SignatureClaimedSigningTime](#signatureclaimedsigningtime-property-secureblackbox_officesigner-class)
- [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-secureblackbox_officesigner-class)
- [SignatureContainsLongTermInfo](#signaturecontainslongterminfo-property-secureblackbox_officesigner-class)
- [SignatureCorePropertiesSigned](#signaturecorepropertiessigned-property-secureblackbox_officesigner-class)
- [SignatureDocumentSigned](#signaturedocumentsigned-property-secureblackbox_officesigner-class)
- [SignatureEntityLabel](#signatureentitylabel-property-secureblackbox_officesigner-class)
- [SignatureExpireTime](#signatureexpiretime-property-secureblackbox_officesigner-class)
- [SignatureHandle](#signaturehandle-property-secureblackbox_officesigner-class)
- [SignatureHashAlgorithm](#signaturehashalgorithm-property-secureblackbox_officesigner-class)
- [SignatureInfoComments](#signatureinfocomments-property-secureblackbox_officesigner-class)
- [SignatureInfoText](#signatureinfotext-property-secureblackbox_officesigner-class)
- [SignatureIssuerRDN](#signatureissuerrdn-property-secureblackbox_officesigner-class)
- [SignatureLastArchivalTime](#signaturelastarchivaltime-property-secureblackbox_officesigner-class)
- [SignatureLevel](#signaturelevel-property-secureblackbox_officesigner-class)
- [SignatureOriginSigned](#signatureoriginsigned-property-secureblackbox_officesigner-class)
- [SignaturePolicyHash](#signaturepolicyhash-property-secureblackbox_officesigner-class)
- [SignaturePolicyHashAlgorithm](#signaturepolicyhashalgorithm-property-secureblackbox_officesigner-class)
- [SignaturePolicyID](#signaturepolicyid-property-secureblackbox_officesigner-class)
- [SignaturePolicyURI](#signaturepolicyuri-property-secureblackbox_officesigner-class)
- [SignatureSerialNumber](#signatureserialnumber-property-secureblackbox_officesigner-class)
- [SignatureSubjectKeyID](#signaturesubjectkeyid-property-secureblackbox_officesigner-class)
- [SignatureSubjectRDN](#signaturesubjectrdn-property-secureblackbox_officesigner-class)
- [SignatureTimestamped](#signaturetimestamped-property-secureblackbox_officesigner-class)
- [SignatureType](#signaturetype-property-secureblackbox_officesigner-class)
- [SignatureValidatedSigningTime](#signaturevalidatedsigningtime-property-secureblackbox_officesigner-class)
- [SignatureValidationLog](#signaturevalidationlog-property-secureblackbox_officesigner-class)
- [SignatureValidationResult](#signaturevalidationresult-property-secureblackbox_officesigner-class)
- [SignatureXAdESVersion](#signaturexadesversion-property-secureblackbox_officesigner-class)

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

# SignatureChainValidationDetails Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The details of a certificate chain validation outcome.

## Object Oriented Interface

```text
public function getSignatureChainValidationDetails($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 232 , $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:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignatureChainValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of a certificate chain validation routine.

## Object Oriented Interface

```text
public function getSignatureChainValidationResult($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 233 , $signatureindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNATURECHAINVALIDATIONRESULT_VALID(0), OFFICESIGNER_SIGNATURECHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(1), OFFICESIGNER_SIGNATURECHAINVALIDATIONRESULT_INVALID(2), OFFICESIGNER_SIGNATURECHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(3)
```

## Default Value

0

## Remarks

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignatureClaimedSigningTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signing time from the signer's computer.

## Object Oriented Interface

```text
public function getSignatureClaimedSigningTime($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 234 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureCompatibilityErrors Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns compatibility errors encountered during validation.

## Object Oriented Interface

```text
public function getSignatureCompatibilityErrors($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 235 , $signatureindex);
```

## Default Value

0

## Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignatureContainsLongTermInfo Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

## Object Oriented Interface

```text
public function getSignatureContainsLongTermInfo($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 236 , $signatureindex);
```

## Default Value

false

## Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignatureCorePropertiesSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSignatureCorePropertiesSigned($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 237 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignatureDocumentSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns True if the signature covers the document itself.

## Object Oriented Interface

```text
public function getSignatureDocumentSigned($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 238 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignatureEntityLabel Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Use this property to get the signature entity label.

## Object Oriented Interface

```text
public function getSignatureEntityLabel($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 239 , $signatureindex);
```

## Default Value

''

## Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureExpireTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the signature expiration time in UTC.

## Object Oriented Interface

```text
public function getSignatureExpireTime($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 240 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSignatureHandle($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 241 , $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.

```text
  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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# SignatureHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The hash algorithm used for signing.

## Object Oriented Interface

```text
public function getSignatureHashAlgorithm($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 242 , $signatureindex);
```

## Default Value

'Unknown'

## Remarks

The hash algorithm used for signing.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSignatureIssuerRDN($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 243 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureLastArchivalTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getSignatureLastArchivalTime($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 244 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureLevel Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies which level or form of XAdES should be produced.

## Object Oriented Interface

```text
public function getSignatureLevel($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 245 , $signatureindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNATURELEVEL_UNKNOWN(0), OFFICESIGNER_SIGNATURELEVEL_GENERIC(1), OFFICESIGNER_SIGNATURELEVEL_BASELINE_B(2), OFFICESIGNER_SIGNATURELEVEL_BASELINE_T(3), OFFICESIGNER_SIGNATURELEVEL_BASELINE_LT(4), OFFICESIGNER_SIGNATURELEVEL_BASELINE_LTA(5), OFFICESIGNER_SIGNATURELEVEL_BES(6), OFFICESIGNER_SIGNATURELEVEL_EPES(7), OFFICESIGNER_SIGNATURELEVEL_T(8), OFFICESIGNER_SIGNATURELEVEL_C(9), OFFICESIGNER_SIGNATURELEVEL_X(10), OFFICESIGNER_SIGNATURELEVEL_XTYPE_1(11), OFFICESIGNER_SIGNATURELEVEL_XTYPE_2(12), OFFICESIGNER_SIGNATURELEVEL_XL(13), OFFICESIGNER_SIGNATURELEVEL_XLTYPE_1(14), OFFICESIGNER_SIGNATURELEVEL_XLTYPE_2(15), OFFICESIGNER_SIGNATURELEVEL_A(16), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_BES(17), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_EPES(18), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_T(19), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_C(20), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_X(21), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XTYPE_1(22), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XTYPE_2(23), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XLONG(24), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XL(25), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XLTYPE_1(26), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_XLTYPE_2(27), OFFICESIGNER_SIGNATURELEVEL_EXTENDED_A(28), OFFICESIGNER_SIGNATURELEVEL_BASELINE_EXTENDED_B(29), OFFICESIGNER_SIGNATURELEVEL_BASELINE_EXTENDED_T(30), OFFICESIGNER_SIGNATURELEVEL_BASELINE_EXTENDED_LT(31), OFFICESIGNER_SIGNATURELEVEL_BASELINE_EXTENDED_LTA(32)
```

## Default Value

6

## Remarks

Specifies which level or form of XAdES should be produced.

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

Use the *Generic* value to produce XML-DSIG signature.

The supported levels and forms are:

|  |  |  |
| --- | --- | --- |
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |

* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2

Note: Microsoft Office supports standard XAdES forms, including BES, EPES, T, X, X-L, A, and Baseline profiles. However, it does not support Extended XAdES forms. Additionally, Microsoft Office versions 2010, 2013, and 2016 do not support the Archive form (*aslA*) or the B-LTA level (*aslBaselineLTA*).

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignaturePolicyHash Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signature policy hash value.

## Object Oriented Interface

```text
public function getSignaturePolicyHash($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 246 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignaturePolicyHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getSignaturePolicyHashAlgorithm($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 247 , $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](#signaturepolicyhash-property-secureblackbox_officesigner-class).

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

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignaturePolicyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSignaturePolicyID($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 248 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignaturePolicyURI Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The signature policy URI that was included in the signature.

## Object Oriented Interface

```text
public function getSignaturePolicyURI($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 249 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureSerialNumber Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The serial number of the signing certificate.

## Object Oriented Interface

```text
public function getSignatureSerialNumber($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 250 , $signatureindex);
```

## Remarks

The serial number of 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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# SignatureBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the binary representation of the Office signature.

## Object Oriented Interface

```text
public function getSignatureBytes($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 251 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# SignatureInfoComments Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the comments for the SignatureInfoText.

## Object Oriented Interface

```text
public function getSignatureInfoComments($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 252 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureInfoText Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the text of the signature info.

## Object Oriented Interface

```text
public function getSignatureInfoText($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 253 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureOriginSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns True if the signature origin is signed.

## Object Oriented Interface

```text
public function getSignatureOriginSigned($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 254 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignatureType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the type of this signature.

## Object Oriented Interface

```text
public function getSignatureType($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 255 , $signatureindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNATURETYPE_DEFAULT(0), OFFICESIGNER_SIGNATURETYPE_BINARY_CRYPTO_API(1), OFFICESIGNER_SIGNATURETYPE_BINARY_XML(2), OFFICESIGNER_SIGNATURETYPE_OPEN_XML(3), OFFICESIGNER_SIGNATURETYPE_OPEN_XPS(4), OFFICESIGNER_SIGNATURETYPE_OPEN_DOCUMENT(5)
```

## Default Value

0

## Remarks

Specifies the type of this signature.

|  |  |  |
| --- | --- | --- |
| ostDefault | 0 |  |
| ostBinaryCryptoAPI | 1 |  |
| ostBinaryXML | 2 |  |
| ostOpenXML | 3 |  |
| ostOpenXPS | 4 |  |
| ostOpenDocument | 5 |  |

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignatureValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of the cryptographic signature validation.

## Object Oriented Interface

```text
public function getSignatureValidationResult($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 256 , $signatureindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNATUREVALIDATIONRESULT_VALID(0), OFFICESIGNER_SIGNATUREVALIDATIONRESULT_UNKNOWN(1), OFFICESIGNER_SIGNATUREVALIDATIONRESULT_CORRUPTED(2), OFFICESIGNER_SIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), OFFICESIGNER_SIGNATUREVALIDATIONRESULT_FAILURE(4), OFFICESIGNER_SIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5)
```

## Default Value

0

## Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignatureSubjectKeyID Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the subject key identifier of the signing certificate.

## Object Oriented Interface

```text
public function getSignatureSubjectKeyID($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 257 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# SignatureSubjectRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains information about the person owning the signing certificate.

## Object Oriented Interface

```text
public function getSignatureSubjectRDN($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 258 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureTimestamped Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSignatureTimestamped($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 259 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignatureValidatedSigningTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the certified signing time.

## Object Oriented Interface

```text
public function getSignatureValidatedSigningTime($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 260 , $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](#signatureclaimedsigningtime-property-secureblackbox_officesigner-class) 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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureValidationLog Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the complete log of the certificate validation routine.

## Object Oriented Interface

```text
public function getSignatureValidationLog($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 261 , $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](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignatureXAdESVersion Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies XAdES version.

## Object Oriented Interface

```text
public function getSignatureXAdESVersion($signatureindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 262 , $signatureindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNATUREXADESVERSION_UNKNOWN(0), OFFICESIGNER_SIGNATUREXADESVERSION_111(1), OFFICESIGNER_SIGNATUREXADESVERSION_122(2), OFFICESIGNER_SIGNATUREXADESVERSION_132(3), OFFICESIGNER_SIGNATUREXADESVERSION_141(4)
```

## Default Value

3

## Remarks

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with.

The supported versions are:

|  |  |  |
| --- | --- | --- |
| xavUnknown | 0 | Unknown |
| xav111 | 1 | XAdES v1.1.1 |
| xav122 | 2 | XAdES v1.2.2 |
| xav132 | 3 | XAdES v1.3.2 |
| xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |

Note: Microsoft Office supports XAdES version 1.3.2 only.

The *$signatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SignedPartCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the SignedPart arrays.

## Object Oriented Interface

```text
public function getSignedPartCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 263 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SignedPartContentType](#signedpartcontenttype-property-secureblackbox_officesigner-class)
- [SignedPartHashAlgorithm](#signedparthashalgorithm-property-secureblackbox_officesigner-class)
- [SignedPartIsRelationshipPart](#signedpartisrelationshippart-property-secureblackbox_officesigner-class)
- [SignedPartPath](#signedpartpath-property-secureblackbox_officesigner-class)
- [SignedPartValidationResult](#signedpartvalidationresult-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Specifies the content type of this signed part.

## Object Oriented Interface

```text
public function getSignedPartContentType($signedpartindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 264 , $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](#signedpartcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignedPartHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The hash algorithm used for signing.

## Object Oriented Interface

```text
public function getSignedPartHashAlgorithm($signedpartindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 265 , $signedpartindex);
```

## Default Value

'Unknown'

## Remarks

The hash algorithm used for signing.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The hash algorithm used for signing.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The *$signedpartindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignedPartCount](#signedpartcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignedPartIsRelationshipPart Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies whether this signed part is a relationship part.

## Object Oriented Interface

```text
public function getSignedPartIsRelationshipPart($signedpartindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 266 , $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](#signedpartcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# SignedPartPath Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The path to this signed part in the document package.

## Object Oriented Interface

```text
public function getSignedPartPath($signedpartindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 267 , $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](#signedpartcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# SignedPartValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of the cryptographic signature validation.

## Object Oriented Interface

```text
public function getSignedPartValidationResult($signedpartindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 268 , $signedpartindex);
```

## Possible Values

```text
OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_VALID(0), OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_UNKNOWN(1), OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_CORRUPTED(2), OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_SIGNER_NOT_FOUND(3), OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_FAILURE(4), OFFICESIGNER_SIGNEDPARTVALIDATIONRESULT_REFERENCE_CORRUPTED(5)
```

## Default Value

0

## Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The *$signedpartindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignedPartCount](#signedpartcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# SigningCertBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getSigningCertBytes();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 269 );
```

## 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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSigningCertHandle();
public function setSigningCertHandle($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 277 );
secureblackbox_officesigner_set($res, 277, $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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is not available at design time.

## Data Type

Long64

# SigningChainCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the SigningChain arrays.

## Object Oriented Interface

```text
public function getSigningChainCount();
public function setSigningChainCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 308 );
secureblackbox_officesigner_set($res, 308, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SigningChainBytes](#signingchainbytes-property-secureblackbox_officesigner-class)
- [SigningChainHandle](#signingchainhandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getSigningChainBytes($signingchainindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 309 , $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](#signingchaincount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# SigningChainHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSigningChainHandle($signingchainindex);
public function setSigningChainHandle($signingchainindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 317 , $signingchainindex);
secureblackbox_officesigner_set($res, 317, $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.

```text
  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](#signingchaincount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# SocketDNSMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSMode();
public function setSocketDNSMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 348 );
secureblackbox_officesigner_set($res, 348, $value );
```

## Possible Values

```text
OFFICESIGNER_SOCKETDNSMODE_AUTO(0), OFFICESIGNER_SOCKETDNSMODE_PLATFORM(1), OFFICESIGNER_SOCKETDNSMODE_OWN(2), OFFICESIGNER_SOCKETDNSMODE_OWN_SECURE(3)
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

## Data Type

Integer

# SocketDNSPort Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSPort();
public function setSocketDNSPort($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 349 );
secureblackbox_officesigner_set($res, 349, $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](#officesigner-class) Class)

The timeout (in milliseconds) for each DNS query.

## Object Oriented Interface

```text
public function getSocketDNSQueryTimeout();
public function setSocketDNSQueryTimeout($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 350 );
secureblackbox_officesigner_set($res, 350, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSServers();
public function setSocketDNSServers($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 351 );
secureblackbox_officesigner_set($res, 351, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSTotalTimeout();
public function setSocketDNSTotalTimeout($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 352 );
secureblackbox_officesigner_set($res, 352, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketIncomingSpeedLimit();
public function setSocketIncomingSpeedLimit($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 353 );
secureblackbox_officesigner_set($res, 353, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketLocalAddress Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The local network interface to bind the socket to.

## Object Oriented Interface

```text
public function getSocketLocalAddress();
public function setSocketLocalAddress($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 354 );
secureblackbox_officesigner_set($res, 354, $value );
```

## Default Value

''

## Remarks

The local network interface to bind the socket to.

## Data Type

String

# SocketLocalPort Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The local port number to bind the socket to.

## Object Oriented Interface

```text
public function getSocketLocalPort();
public function setSocketLocalPort($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 355 );
secureblackbox_officesigner_set($res, 355, $value );
```

## Default Value

0

## Remarks

The local port number to bind the socket to.

## Data Type

Integer

# SocketOutgoingSpeedLimit Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketOutgoingSpeedLimit();
public function setSocketOutgoingSpeedLimit($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 356 );
secureblackbox_officesigner_set($res, 356, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketTimeout Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getSocketTimeout();
public function setSocketTimeout($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 357 );
secureblackbox_officesigner_set($res, 357, $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](#officesigner-class) Class)

Enables or disables IP protocol version 6.

## Object Oriented Interface

```text
public function getSocketUseIPv6();
public function setSocketUseIPv6($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 358 );
secureblackbox_officesigner_set($res, 358, $value );
```

## Default Value

false

## Remarks

Enables or disables IP protocol version 6.

## Data Type

Boolean

# TimestampCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the Timestamp arrays.

## Object Oriented Interface

```text
public function getTimestampCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 359 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TimestampAccuracy](#timestampaccuracy-property-secureblackbox_officesigner-class)
- [TimestampBytes](#timestampbytes-property-secureblackbox_officesigner-class)
- [TimestampCertificateIndex](#timestampcertificateindex-property-secureblackbox_officesigner-class)
- [TimestampChainValidationDetails](#timestampchainvalidationdetails-property-secureblackbox_officesigner-class)
- [TimestampChainValidationResult](#timestampchainvalidationresult-property-secureblackbox_officesigner-class)
- [TimestampContainsLongTermInfo](#timestampcontainslongterminfo-property-secureblackbox_officesigner-class)
- [TimestampEntityLabel](#timestampentitylabel-property-secureblackbox_officesigner-class)
- [TimestampHashAlgorithm](#timestamphashalgorithm-property-secureblackbox_officesigner-class)
- [TimestampParentEntity](#timestampparententity-property-secureblackbox_officesigner-class)
- [TimestampSerialNumber](#timestampserialnumber-property-secureblackbox_officesigner-class)
- [TimestampTime](#timestamptime-property-secureblackbox_officesigner-class)
- [TimestampTSAName](#timestamptsaname-property-secureblackbox_officesigner-class)
- [TimestampType](#timestamptype-property-secureblackbox_officesigner-class)
- [TimestampValidationLog](#timestampvalidationlog-property-secureblackbox_officesigner-class)
- [TimestampValidationResult](#timestampvalidationresult-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTimestampAccuracy($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 360 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# TimestampBytes Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the raw timestamp data in DER format.

## Object Oriented Interface

```text
public function getTimestampBytes($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 361 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TimestampCertificateIndex Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTimestampCertificateIndex($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 362 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TimestampChainValidationDetails Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The details of a certificate chain validation outcome.

## Object Oriented Interface

```text
public function getTimestampChainValidationDetails($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 363 , $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:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TimestampChainValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The outcome of a certificate chain validation routine.

## Object Oriented Interface

```text
public function getTimestampChainValidationResult($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 364 , $timestampindex);
```

## Possible Values

```text
OFFICESIGNER_TIMESTAMPCHAINVALIDATIONRESULT_VALID(0), OFFICESIGNER_TIMESTAMPCHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(1), OFFICESIGNER_TIMESTAMPCHAINVALIDATIONRESULT_INVALID(2), OFFICESIGNER_TIMESTAMPCHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(3)
```

## Default Value

0

## Remarks

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TimestampContainsLongTermInfo Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

## Object Oriented Interface

```text
public function getTimestampContainsLongTermInfo($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 365 , $timestampindex);
```

## Default Value

false

## Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# TimestampEntityLabel Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Use this property to get the timestamp entity label.

## Object Oriented Interface

```text
public function getTimestampEntityLabel($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 366 , $timestampindex);
```

## Default Value

''

## Remarks

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampHashAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the timestamp's hash algorithm.

## Object Oriented Interface

```text
public function getTimestampHashAlgorithm($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 367 , $timestampindex);
```

## Default Value

''

## Remarks

Returns the timestamp's hash algorithm.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampParentEntity Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Use this property to get the label of the timestamp's parent entity.

## Object Oriented Interface

```text
public function getTimestampParentEntity($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 368 , $timestampindex);
```

## Default Value

''

## Remarks

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampSerialNumber Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the timestamp's serial number.

## Object Oriented Interface

```text
public function getTimestampSerialNumber($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 369 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TimestampTime Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The time point incorporated into the timestamp.

## Object Oriented Interface

```text
public function getTimestampTime($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 370 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampType Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the type of the timestamp.

## Object Oriented Interface

```text
public function getTimestampType($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 371 , $timestampindex);
```

## Default Value

0

## Remarks

Returns the type of the timestamp.

Available options:

|  |  |  |
| --- | --- | --- |
| tstUnknown | 0 |  |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |

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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TimestampTSAName Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

This value uniquely identifies the Timestamp Authority (TSA).

## Object Oriented Interface

```text
public function getTimestampTSAName($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 372 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampValidationLog Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the TSA certificate chain validation log.

## Object Oriented Interface

```text
public function getTimestampValidationLog($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 373 , $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](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TimestampValidationResult Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Contains the timestamp validation outcome.

## Object Oriented Interface

```text
public function getTimestampValidationResult($timestampindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 374 , $timestampindex);
```

## Possible Values

```text
OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_VALID(0), OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_UNKNOWN(1), OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_CORRUPTED(2), OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_SIGNER_NOT_FOUND(3), OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_FAILURE(4), OFFICESIGNER_TIMESTAMPVALIDATIONRESULT_REFERENCE_CORRUPTED(5)
```

## Default Value

0

## Remarks

Contains the timestamp validation outcome.

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

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The *$timestampindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestampcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TimestampServer Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The address of the timestamping server.

## Object Oriented Interface

```text
public function getTimestampServer();
public function setTimestampServer($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 375 );
secureblackbox_officesigner_set($res, 375, $value );
```

## Default Value

''

## Remarks

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The *ignorenonce* parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

## Data Type

String

# TLSClientCertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the TLSClientCert arrays.

## Object Oriented Interface

```text
public function getTLSClientCertCount();
public function setTLSClientCertCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 376 );
secureblackbox_officesigner_set($res, 376, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TLSClientCertBytes](#tlsclientcertbytes-property-secureblackbox_officesigner-class)
- [TLSClientCertHandle](#tlsclientcerthandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getTLSClientCertBytes($tlsclientcertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 377 , $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](#tlsclientcertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TLSClientCertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSClientCertHandle($tlsclientcertindex);
public function setTLSClientCertHandle($tlsclientcertindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 385 , $tlsclientcertindex);
secureblackbox_officesigner_set($res, 385, $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.

```text
  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](#tlsclientcertcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# TLSServerCertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the TLSServerCert arrays.

## Object Oriented Interface

```text
public function getTLSServerCertCount();
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 416 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_officesigner-class)
- [TLSServerCertFingerprint](#tlsservercertfingerprint-property-secureblackbox_officesigner-class)
- [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_officesigner-class)
- [TLSServerCertIssuer](#tlsservercertissuer-property-secureblackbox_officesigner-class)
- [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-secureblackbox_officesigner-class)
- [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-secureblackbox_officesigner-class)
- [TLSServerCertKeyBits](#tlsservercertkeybits-property-secureblackbox_officesigner-class)
- [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-secureblackbox_officesigner-class)
- [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-secureblackbox_officesigner-class)
- [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-secureblackbox_officesigner-class)
- [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-secureblackbox_officesigner-class)
- [TLSServerCertSubject](#tlsservercertsubject-property-secureblackbox_officesigner-class)
- [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-secureblackbox_officesigner-class)
- [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-secureblackbox_officesigner-class)
- [TLSServerCertValidTo](#tlsservercertvalidto-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getTLSServerCertBytes($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 417 , $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](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TLSServerCertFingerprint Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertFingerprint($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 423 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertHandle($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 425 , $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.

```text
  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](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Long64

# TLSServerCertIssuer Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertIssuer($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 427 , $tlsservercertindex);
```

## Default Value

''

## Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [TLSIssuerRDN](#OfficeSigner_p_TLSIssuerRDN).

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertIssuerRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

## Object Oriented Interface

```text
public function getTLSServerCertIssuerRDN($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 428 , $tlsservercertindex);
```

## Default Value

''

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertKeyAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the public key algorithm of this certificate.

## Object Oriented Interface

```text
public function getTLSServerCertKeyAlgorithm($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 429 , $tlsservercertindex);
```

## Default Value

'0'

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [TLSKeyBits](#OfficeSigner_p_TLSKeyBits), [TLSCurve](#OfficeSigner_p_TLSCurve), and [TLSPublicKeyBytes](#OfficeSigner_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertKeyBits Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the length of the public key in bits.

## Object Oriented Interface

```text
public function getTLSServerCertKeyBits($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 430 , $tlsservercertindex);
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [TLSPublicKeyBytes](#OfficeSigner_p_TLSPublicKeyBytes) or [TLSPrivateKeyBytes](#OfficeSigner_p_TLSPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TLSServerCertKeyUsage Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertKeyUsage($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 432 , $tlsservercertindex);
```

## Default Value

0

## Remarks

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

This value is a bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Integer

# TLSServerCertSelfSigned Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertSelfSigned($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 445 , $tlsservercertindex);
```

## Default Value

false

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Boolean

# TLSServerCertSerialNumber Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Returns the certificate's serial number.

## Object Oriented Interface

```text
public function getTLSServerCertSerialNumber($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 446 , $tlsservercertindex);
```

## Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TLSServerCertSigAlgorithm Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertSigAlgorithm($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 447 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertSubject Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getTLSServerCertSubject($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 449 , $tlsservercertindex);
```

## Default Value

''

## Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [TLSSubjectRDN](#OfficeSigner_p_TLSSubjectRDN).

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertSubjectRDN Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

## Object Oriented Interface

```text
public function getTLSServerCertSubjectRDN($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 452 , $tlsservercertindex);
```

## Default Value

''

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertValidFrom Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertValidFrom($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 454 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSServerCertValidTo Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertValidTo($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 455 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

String

# TLSAutoValidateCertificates Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSAutoValidateCertificates();
public function setTLSAutoValidateCertificates($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 456 );
secureblackbox_officesigner_set($res, 456, $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](#officesigner-class) Class)

Selects the base configuration for the TLS settings.

## Object Oriented Interface

```text
public function getTLSBaseConfiguration();
public function setTLSBaseConfiguration($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 457 );
secureblackbox_officesigner_set($res, 457, $value );
```

## Possible Values

```text
OFFICESIGNER_TLSBASECONFIGURATION_DEFAULT(0), OFFICESIGNER_TLSBASECONFIGURATION_COMPATIBLE(1), OFFICESIGNER_TLSBASECONFIGURATION_COMPREHENSIVE_INSECURE(2), OFFICESIGNER_TLSBASECONFIGURATION_HIGHLY_SECURE(3)
```

## Default Value

0

## Remarks

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

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

## Data Type

Integer

# TLSCiphersuites Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

A list of ciphersuites separated with commas or semicolons.

## Object Oriented Interface

```text
public function getTLSCiphersuites();
public function setTLSCiphersuites($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 458 );
secureblackbox_officesigner_set($res, 458, $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](#tlsbaseconfiguration-property-secureblackbox_officesigner-class). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

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

## Data Type

String

# TLSClientAuth Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Enables or disables certificate-based client authentication.

## Object Oriented Interface

```text
public function getTLSClientAuth();
public function setTLSClientAuth($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 459 );
secureblackbox_officesigner_set($res, 459, $value );
```

## Possible Values

```text
OFFICESIGNER_TLSCLIENTAUTH_NO_AUTH(0), OFFICESIGNER_TLSCLIENTAUTH_REQUEST_CERT(1), OFFICESIGNER_TLSCLIENTAUTH_REQUIRE_CERT(2)
```

## Default Value

0

## Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

## Data Type

Integer

# TLSExtensions Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Provides access to TLS extensions.

## Object Oriented Interface

```text
public function getTLSExtensions();
public function setTLSExtensions($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 460 );
secureblackbox_officesigner_set($res, 460, $value );
```

## Default Value

''

## Remarks

Provides access to TLS extensions.

## Data Type

String

# TLSForceResumeIfDestinationChanges Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSForceResumeIfDestinationChanges();
public function setTLSForceResumeIfDestinationChanges($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 461 );
secureblackbox_officesigner_set($res, 461, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# TLSGroups Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

## Object Oriented Interface

```text
public function getTLSGroups();
public function setTLSGroups($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 462 );
secureblackbox_officesigner_set($res, 462, $value );
```

## Default Value

''

## Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder:

```text
  // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
  client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";

  // Only enable the hybrid X25519/ML-KEM768 group
  client.TLSSettings.Groups = "-all;+x25519mlkem768";
```

The list of groups supported by the component is provided below. All the names are case-insensitive:

**Elliptic curve-based groups:**

- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024

Note: this property was called *ECCurves* in SecureBlackbox 2024 and older.

## Data Type

String

# TLSPreSharedIdentity Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedIdentity();
public function setTLSPreSharedIdentity($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 463 );
secureblackbox_officesigner_set($res, 463, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedKey();
public function setTLSPreSharedKey($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 464 );
secureblackbox_officesigner_set($res, 464, $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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedKeyCiphersuite();
public function setTLSPreSharedKeyCiphersuite($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 465 );
secureblackbox_officesigner_set($res, 465, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# TLSRenegotiationAttackPreventionMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Selects the renegotiation attack prevention mechanism.

## Object Oriented Interface

```text
public function getTLSRenegotiationAttackPreventionMode();
public function setTLSRenegotiationAttackPreventionMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 466 );
secureblackbox_officesigner_set($res, 466, $value );
```

## Possible Values

```text
OFFICESIGNER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_COMPATIBLE(0), OFFICESIGNER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_STRICT(1), OFFICESIGNER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_AUTO(2)
```

## Default Value

2

## Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

## Data Type

Integer

# TLSRevocationCheck Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSRevocationCheck();
public function setTLSRevocationCheck($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 467 );
secureblackbox_officesigner_set($res, 467, $value );
```

## Possible Values

```text
OFFICESIGNER_TLSREVOCATIONCHECK_NONE(0), OFFICESIGNER_TLSREVOCATIONCHECK_AUTO(1), OFFICESIGNER_TLSREVOCATIONCHECK_ALL_CRL(2), OFFICESIGNER_TLSREVOCATIONCHECK_ALL_OCSP(3), OFFICESIGNER_TLSREVOCATIONCHECK_ALL_CRLAND_OCSP(4), OFFICESIGNER_TLSREVOCATIONCHECK_ANY_CRL(5), OFFICESIGNER_TLSREVOCATIONCHECK_ANY_OCSP(6), OFFICESIGNER_TLSREVOCATIONCHECK_ANY_CRLOR_OCSP(7), OFFICESIGNER_TLSREVOCATIONCHECK_ANY_OCSPOR_CRL(8)
```

## Default Value

1

## Remarks

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

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

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

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

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

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

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

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

This property is not available at design time.

## Data Type

Integer

# TLSSSLOptions Property ([SecureBlackbox_OfficeSigner](#officesigner-class) 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

```text
public function getTLSSSLOptions();
public function setTLSSSLOptions($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 468 );
secureblackbox_officesigner_set($res, 468, $value );
```

## Default Value

16

## Remarks

Various SSL (TLS) protocol options, set of

|  |  |  |
| --- | --- | --- |
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

## Data Type

Integer

# TLSMode Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Specifies the TLS mode to use.

## Object Oriented Interface

```text
public function getTLSMode();
public function setTLSMode($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 469 );
secureblackbox_officesigner_set($res, 469, $value );
```

## Possible Values

```text
OFFICESIGNER_TLSMODE_DEFAULT(0), OFFICESIGNER_TLSMODE_NO_TLS(1), OFFICESIGNER_TLSMODE_EXPLICIT_TLS(2), OFFICESIGNER_TLSMODE_IMPLICIT_TLS(3), OFFICESIGNER_TLSMODE_MIXED_TLS(4)
```

## Default Value

0

## Remarks

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

## Data Type

Integer

# TLSUseExtendedMasterSecret Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTLSUseExtendedMasterSecret();
public function setTLSUseExtendedMasterSecret($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 470 );
secureblackbox_officesigner_set($res, 470, $value );
```

## Default Value

true

## Remarks

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

## Data Type

Boolean

# TLSUseSessionResumption Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Enables or disables the TLS session resumption capability.

## Object Oriented Interface

```text
public function getTLSUseSessionResumption();
public function setTLSUseSessionResumption($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 471 );
secureblackbox_officesigner_set($res, 471, $value );
```

## Default Value

false

## Remarks

Enables or disables the TLS session resumption capability.

## Data Type

Boolean

# TLSVersions Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The SSL/TLS versions to enable by default.

## Object Oriented Interface

```text
public function getTLSVersions();
public function setTLSVersions($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 472 );
secureblackbox_officesigner_set($res, 472, $value );
```

## Default Value

48

## Remarks

The SSL/TLS versions to enable by default.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Data Type

Integer

# TrustedCertCount Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

The number of records in the TrustedCert arrays.

## Object Oriented Interface

```text
public function getTrustedCertCount();
public function setTrustedCertCount($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 473 );
secureblackbox_officesigner_set($res, 473, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TrustedCertBytes](#trustedcertbytes-property-secureblackbox_officesigner-class)
- [TrustedCertHandle](#trustedcerthandle-property-secureblackbox_officesigner-class)

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](#officesigner-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getTrustedCertBytes($trustedcertindex);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 474 , $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](#trustedcertcount-property-secureblackbox_officesigner-class) property.

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

## Data Type

Byte Array

# TrustedCertHandle Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getTrustedCertHandle($trustedcertindex);
public function setTrustedCertHandle($trustedcertindex, $value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 482 , $trustedcertindex);
secureblackbox_officesigner_set($res, 482, $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.

```text
  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](#trustedcertcount-property-secureblackbox_officesigner-class) property.

This property is not available at design time.

## Data Type

Long64

# ValidationMoment Property ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function getValidationMoment();
public function setValidationMoment($value);
```

## Procedural Interface

```text
secureblackbox_officesigner_get($res, 513 );
secureblackbox_officesigner_set($res, 513, $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

# Close Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Closes an opened document.

## Object Oriented Interface

```text
public function doClose($savechanges);
```

## Procedural Interface

```text
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](#officesigner-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
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](#config-settings-officesigner-class) 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](#config-settings-officesigner-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoAction Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Performs an additional action.

## Object Oriented Interface

```text
public function doDoAction($actionid, $actionparams);
```

## Procedural Interface

```text
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;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# ExtractAsyncData Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Extracts user data from the DC signing service response.

## Object Oriented Interface

```text
public function doExtractAsyncData($asyncreply);
```

## Procedural Interface

```text
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](#officesigner-class) Class)

Opens a document for signing or updating.

## Object Oriented Interface

```text
public function doOpen();
```

## Procedural Interface

```text
secureblackbox_officesigner_do_open($res);
```

## Remarks

Use this method to open a document for signing or updating. When finished, call [Close](#close-method-secureblackbox_officesigner-class) to complete or discard the operation.

# Reset Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Resets the class settings.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
secureblackbox_officesigner_do_reset($res);
```

## Remarks

Reset is a generic method available in every class.

# Revalidate Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Revalidates a signature in accordance with current settings.

## Object Oriented Interface

```text
public function doRevalidate($siglabel);
```

## Procedural Interface

```text
secureblackbox_officesigner_do_revalidate($res, $siglabel);
```

## Remarks

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

# SelectInfo Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Select signature information for a specific entity.

## Object Oriented Interface

```text
public function doSelectInfo($entitylabel, $infotype, $clearselection);
```

## Procedural Interface

```text
secureblackbox_officesigner_do_selectinfo($res, $entitylabel, $infotype, $clearselection);
```

## Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the *EntityLabel* parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

|  |  |  |
| --- | --- | --- |
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping *ClearSelection* set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

# Sign Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Calculates the signature value.

## Object Oriented Interface

```text
public function doSign();
```

## Procedural Interface

```text
secureblackbox_officesigner_do_sign($res);
```

## Remarks

Call this method to generate a signature over the document.

# SignAsyncBegin Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Initiates the asynchronous signing operation.

## Object Oriented Interface

```text
public function doSignAsyncBegin();
```

## Procedural Interface

```text
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](#outputfile-property-secureblackbox_officesigner-class) (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](#inputfile-property-secureblackbox_officesigner-class) (or InputStream), and call [SignAsyncEnd](#signasyncend-method-secureblackbox_officesigner-class) 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](#signasyncend-method-secureblackbox_officesigner-class) 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](#signasyncend-method-secureblackbox_officesigner-class) method.

# SignAsyncEnd Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Completes the asynchronous signing operation.

## Object Oriented Interface

```text
public function doSignAsyncEnd($asyncreply);
```

## Procedural Interface

```text
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](#signasyncbegin-method-secureblackbox_officesigner-class) call to [InputFile](#inputfile-property-secureblackbox_officesigner-class) (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to [OutputFile](#outputfile-property-secureblackbox_officesigner-class) (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](#signasyncbegin-method-secureblackbox_officesigner-class)) 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](#signasyncbegin-method-secureblackbox_officesigner-class) 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](#officesigner-class) Class)

Signs the document using an external signing facility.

## Object Oriented Interface

```text
public function doSignExternal();
```

## Procedural Interface

```text
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](#externalsign-event-secureblackbox_officesigner-class) event which allows to pass the hash value for signing.

# Timestamp Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Use this method to add an timestamp.

## Object Oriented Interface

```text
public function doTimestamp($siglabel, $timestamptype);
```

## Procedural Interface

```text
secureblackbox_officesigner_do_timestamp($res, $siglabel, $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](#signaturevalidated-event-secureblackbox_officesigner-class) event handler after successful signature validation. Use the *TimestampType* parameter to specify the type of timestamp to create

Supported timestamp types:

|  |  |  |
| --- | --- | --- |
| tstSignature | 12 | Signature timestamp |
| tstRefsOnly | 13 | RefsOnly timestamp |
| tstSigAndRefs | 14 | SigAndRefs timestamp |
| tstArchive | 7 | Archive timestamp |

# Upgrade Method ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Upgrades existing XAdES signature to a new form.

## Object Oriented Interface

```text
public function doUpgrade($siglabel, $upgradekind);
```

## Procedural Interface

```text
secureblackbox_officesigner_do_upgrade($res, $siglabel, $upgradekind);
```

## 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 or level specified by *UpgradeKind*. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).

The supported levels and forms are:

|  |  |  |
| --- | --- | --- |
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |

The supported additional upgrade kinds are:

|  |  |  |
| --- | --- | --- |
| xukAddValidationDataRefs | 256 | Add signature validation references |
| xukAddValidationDataValues | 512 | Add signature validation values |
| xukAddTimestampValidationData | 1024 | Add timestamp validation data |
| xukAddAnyValidationData | 2048 | Add AnyValidationData |

# ChainElementDownload Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireChainElementDownload($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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.

|  |  |  |
| --- | --- | --- |
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# ChainElementNeeded Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireChainElementNeeded($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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.

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# ChainElementStore Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireChainElementStore($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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.

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# ChainValidated Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Reports the completion of a certificate chain validation.

## Object Oriented Interface

```text
public function fireChainValidated($param);
```

## Procedural Interface

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

## Parameter List

```text
 'index' 'entitylabel' 'subjectrdn' 'validationresult' 'validationdetails' 'cancel'
```

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

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

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

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

# ChainValidationProgress Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireChainValidationProgress($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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.

|  |  |  |
| --- | --- | --- |
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |

# DocumentLoaded Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireDocumentLoaded($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#officesigner-class) Class)

Information about errors during signing.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireExternalSign($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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:

```text
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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireNotification($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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:

|  |  |
| --- | --- |
| DocumentLoaded | Reports the completion of Office document processing by the component. Use the event handler to access document-related information. The EventParam value passed with this EventID is empty. |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping authority. This event is only fired if [TimestampServer](#timestampserver-property-secureblackbox_officesigner-class) was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to [TimestampServer](#timestampserver-property-secureblackbox_officesigner-class)), in base16, that needs to be sent to the TSA. Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |

# SignatureFound Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Signifies the start of signature validation.

## Object Oriented Interface

```text
public function fireSignatureFound($param);
```

## Procedural Interface

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

## Parameter List

```text
 'index' 'entitylabel' '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](#officesigner-class) Class)

Marks the completion of the signature validation routine.

## Object Oriented Interface

```text
public function fireSignatureValidated($param);
```

## Procedural Interface

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

## Parameter List

```text
 'index' 'entitylabel' 'issuerrdn' 'serialnumber' 'subjectkeyid' 'validationresult' 'cancel'
```

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

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# TimestampFound Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Signifies the start of a timestamp validation routine.

## Object Oriented Interface

```text
public function fireTimestampFound($param);
```

## Procedural Interface

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

## Parameter List

```text
 'index' 'entitylabel' '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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireTimestampRequest($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#timestampserver-property-secureblackbox_officesigner-class) property. Set the *SuppressDefault* parameter to true if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned *TimestampResponse* parameter is not empty.

# TimestampValidated Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Reports the completion of the timestamp validation routine.

## Object Oriented Interface

```text
public function fireTimestampValidated($param);
```

## Procedural Interface

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

## Parameter List

```text
 'index' 'entitylabel' 'issuerrdn' 'serialnumber' 'subjectkeyid' 'time' 'validationresult' 'chainvalidationresult' 'chainvalidationdetails' 'cancel'
```

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

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# TLSCertNeeded Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Fires when a remote TLS party requests a client certificate.

## Object Oriented Interface

```text
public function fireTLSCertNeeded($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#tlshandshake-event-secureblackbox_officesigner-class) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-secureblackbox_officesigner-class) event.

# TLSCertValidate Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireTLSCertValidate($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#officesigner-class) Class)

Fires when a TLS handshake with Host successfully completes.

## Object Oriented Interface

```text
public function fireTLSEstablished($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#officesigner-class) Class)

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

## Object Oriented Interface

```text
public function fireTLSHandshake($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#tlsestablished-event-secureblackbox_officesigner-class) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-secureblackbox_officesigner-class) event will also be fired.

# TLSShutdown Event ([SecureBlackbox_OfficeSigner](#officesigner-class) Class)

Reports the graceful closure of a TLS connection.

## Object Oriented Interface

```text
public function fireTLSShutdown($param);
```

## Procedural Interface

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

## Parameter List

```text
 '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](#officesigner-class) 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](#config-method-secureblackbox_officesigner-class) method.

### OfficeSigner Config Settings

**AddAllDataObjectsTimestamp**: Whether to add all data objects timestamp during signing.If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.

**AsyncDocumentID**: Specifies the document ID for SignAsyncEnd() call.Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

**CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

**CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. A value of 0 disables the OCSP response ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

**ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step.

**ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated.

**ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed.

**ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed.

**ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed.

**ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed.

**ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details.

**ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

**CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates.

**ClaimedRolesXML**: The XML content of the claimed roles.Use this property to get/specify the XML content of the claimed roles element.

**ClaimedRoleText**: The text of the claimed role.Use this property to get/specify the text of the first claimed role.

**CommitmentTypeIndicationAllSignedDataObjects[Index]**: Specifies the CommitmentTypeIndication's AllSignedDataObjects.This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationCount**: The number of the CommitmentTypeIndication elements.Returns the number of the xades:CommitmentTypeIndication elements available.

**CommitmentTypeIndicationIdentifier[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationIdentifierDescription[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationIdentifierDocumentationReferences[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationIdentifierQualifier[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationObjectReference[Index]**: Specifies the CommitmentTypeIndication's ObjectReference.This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.

**CommitmentTypeIndicationQualifiersXML[Index]**: The XML content of the CommitmentTypeIndication's Qualifiers.This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.

**CompressionLevel**: Contains the compression level of the document.Use this property to get or set the compression level (1..9) of the Open XML, Open XPS, or OpenDocument format document. 1 stand for the lightest but fastest compression, and 9 for the best but the slowest.

Note: The document should be open to be able to get or set the compression level.

**CustomTrustedLists**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

**CustomTSLs**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

**DataObjectFormatCount**: The number of the DataObjectFormat elements.Returns the number of the xades:DataObjectFormat elements available.

**DataObjectFormatDescription[Index]**: Specifies the DataObjectFormat's Description.This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatEncoding[Index]**: Specifies the DataObjectFormat's Encoding.This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatMimeType[Index]**: Specifies the DataObjectFormat's MimeType.This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatObjectIdentifier[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's Identifier.This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatObjectIdentifierDescription[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's Description.This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatObjectIdentifierDocumentationReferences[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatObjectIdentifierQualifier[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.

**DataObjectFormatObjectReference[Index]**: Specifies the DataObjectFormat's ObjectReference.This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.

For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.

Index value could be omitted for the first DataObjectFormat element.

**DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during revocation checks performed by the AdES component.

The default value is **dcrlpPreferComplete** (1).

Supported values:

- **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

**DislikeOpenEndedOCSPs**: Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

**EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures.

**EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

**EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

**ExclusiveCanonicalizationPrefix**: Specifies the exclusive canonicalization prefix.Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.

Default value is "ec". In this case "ec:" prefix will be used.

Special values:

|  |  |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |

**ExpireTime**: Signature expiration time in UTC.Specifies the signature expiration time in UTC. Used for Binary Crypto API signature.

**ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

**ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

**GracePeriod**: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

**HMACKey**: The key value for HMAC.Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value.

**HMACOutputLength**: Sets the length of the HMAC output.Use this property to configure the length of the HMAC output, in bytes.

**HMACSigningUsed**: Whether to use HMAC signing.Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. TBD

**IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

**IgnoreChainValidationErrors**: Whether to ignore any certificate chain validation issues.Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.

**IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

**IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

**IgnoreTimestampFailure**: Whether to ignore time-stamping failure during signing.If this property is set to True, any failure during time-stamping process will be ignored.

**ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings.

**IncludeKnownRevocationInfoToSignature**: Whether to include custom revocation info to the signature.This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

**InclusiveNamespacesPrefixList**: Specifies the InclusiveNamespaces PrefixList.Use this property to read/specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

**KeyInfoID**: Specifies the ID for KeyInfo element.This property contains the identifier (ID) attribute of the ds:KeyInfo element.

**KeyName**: Contains information about the key used for signing.The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.

**PolicyDescription**: signature policy description.This property specifies the Description of the signature policy.

**PolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

**PolicyUNNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

**PolicyUNOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

**ProductionPlace**: Identifies the place of the signature production.The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

**PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

**PSSUsed**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for *UsePSS*.

**QualifyingPropertiesID**: Specifies the ID for QualifyingProperties element.This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.

**QualifyingPropertiesObjectID**: Specifies the ID for object with QualifyingProperties element.This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.

**QualifyingPropertiesReferenceCount**: The number of the QualifyingPropertiesReference elements.Returns the number of the xades:QualifyingPropertiesReference elements available.

**QualifyingPropertiesReferenceID[Index]**: Specifies the QualifyingPropertiesReference's ID.This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

**QualifyingPropertiesReferenceURI[Index]**: Specifies the QualifyingPropertiesReference's URI.This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

**RefsTimestampType**: Specifies references timestamp type to include to the signature.Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.

Supported values are:

|  |  |  |
| --- | --- | --- |
| SigAndRefs |  | SigAndRefs timestamp |
| RefsOnly |  | RefsOnly timestamp |

**RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Default.

Supported values are case-insensitive:

|  |  |
| --- | --- |
| Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap> | Sets the CRL and OCSP response freshness values explicitly. |

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

**SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*.

**SignatureID**: Specifies the ID for Signature element.This property contains the identifier (ID) attribute of the ds:Signature element.

**SignatureInfoAddress1**: Specifies the location at which the signature was created.Use this property to specify the location at which the signature was created.

**SignatureInfoAddress2**: Specifies the location at which the signature was created.Use this property to specify the location at which the signature was created.

**SignatureInfoComments**: Comments to the signature info text.Comments to the signature info text.

**SignatureInfoDelegateSuggestedSigner**: Specifies the name of a person.Use this property to specify the name of a person to whom the signature has been delegated.

**SignatureInfoDelegateSuggestedSigner2**: Specifies the title of a person.Use this property to specify the title of a person to whom the signature has been delegated.

**SignatureInfoDelegateSuggestedSignerEmail**: Specifies the e-mail address of a person.Use this property to specify the e-mail address of a person to whom the signature has been delegated.

**SignatureInfoImage**: Specifies an image for the digital signature.Use his property to set an image for the digital signature.

**SignatureInfoIncluded**: Whether to include the signature info.Specifies whether to include the signature info.

Sample code that demonstrates adding signature information for OpenXML documents:

```text
signer.NewSignature.Level = aslEPES;
signer.Config("SignatureInfoIncluded=true");
signer.Config("SignatureInfoText=Text");
signer.Config("SignatureInfoComments=Comment");
signer.Config("ClaimedRoleText=Role");
signer.Config("CommitmentTypeIndicationCount=1");
signer.Config("CommitmentTypeIndicationAllSignedDataObjects=true");
signer.Config("CommitmentTypeIndicationIdentifier=http://uri.etsi.org/01903/v1.2.2#ProofOfApproval");
signer.Config("CommitmentTypeIndicationIdentifierDescription=Approved this document");
signer.Config("ProductionPlace=CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country");
signer.Config("SignatureInfoAddress1=Address1");
signer.Config("SignatureInfoAddress2=Address2");
```

**SignatureInfoInvalidLnImage**: Specifies the image of an invalid signature.Use this property to set the image of an invalid signature, if the digital signature must be printed.

**SignatureInfoSignatureType**: Specifies the type of the digital signature.Use this property to specify the type of the digital signature.

When the type is 2, both SignatureInfoValidLnImage and SignatureInfoInvalidLnImage images should be specified.

**SignatureInfoText**: The text to be displayed as the signature info.The text to be displayed as the signature info.

**SignatureInfoValidLnImage**: Specifies the image of a valid signature.Use this property to set the image of a valid signature, if the digital signature must be printed.

**SignatureLineAdditionalSignatureInfo[Index]**: Contains additional signature information.This property contains additional signature information.

**SignatureLineAllowComments[Index]**: Indicates if comments are allowed.This property contains the True value if comments are allowed.

**SignatureLineCount**: The number of signature lines.Returns the number of the signature lines available for Office Open XML (OOXML) documents.

**SignatureLineId[Index]**: Contains signature unique ID.This property contains signature unique ID.

**SignatureLineImageData[Index]**: Contains signature image.This property contains signature image.

**SignatureLineIndex**: Specifies the index of the signature line to sign.Use this property to specify the signature line that should be signed. If the default value of -1 is assigned to this property, no signature line will be signed.

**SignatureLineShowSignDate[Index]**: Indicates if signing date should be shown.This property contains the True value if the signature line should include the signing date.

**SignatureLineSignatureIndex[Index]**: The index of the signature that signs signature line.This property contains the index of the signature that signs this signature line.

**SignatureLineSignatureProviderId[Index]**: Contains signature provider ID.This property contains a unique ID identifying which signature provider created the signature line.

**SignatureLineSignatureProviderUrl[Index]**: Contains signature provider URL.This property contains a signature provider download URL.

**SignatureLineSigned[Index]**: Indicates if signature line is signed.This property contains the True value if signature line is signed.

**SignatureLineSigningInstructions[Index]**: Contains signing instructions.This property contains the instructions, shown to the user at signing time.

**SignatureLineSuggestedSigner2[Index]**: Suggested signer line two.This property contains the second line of information of who should sign the signature line.

**SignatureLineSuggestedSigner[Index]**: Suggested signer line one.This property contains the first line of information of who should sign the signature line.

**SignatureLineSuggestedSignerEmail[Index]**: Suggested signer email address.This property contains the email address of who should sign the signature line.

**SignatureOriginPartURI**: Contains the signature origin part URI element.Use this property to get or set the signature origin part URI record.

Note: The document should be open to be able to get or set the compression level.

**SignaturePartName**: Name of signature part.Use this property to specify the custom name of the signature part for Open XML documents.

**SignaturePrefix**: Specifies the signature prefix.Specifies the prefix for the Signature elements.

Default value is "ds". In this case "ds:" prefix will be used.

Special values:

|  |  |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |

**SignatureValueID**: Specifies the ID for SignatureValue element.This property contains the identifier (ID) attribute of the ds:SignatureValue element.

**SignedInfoID**: Specifies the ID for SignedInfo element.This property contains the identifier (ID) attribute of the ds:SignedInfo element.

**SignedPropertiesID**: Specifies the ID for SignedProperties element.This property contains the identifier (ID) attribute of the xades:SignedProperties element.

**SignedPropertiesReferenceCanonicalizationMethod**: Specifies the canonicalization method used in SignedProperties reference.Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.

|  |  |  |
| --- | --- | --- |
| cxcmNone | 0 |  |
| cxcmCanon | 1 |  |
| cxcmCanonComment | 2 |  |
| cxcmExclCanon | 3 |  |
| cxcmExclCanonComment | 4 |  |
| cxcmMinCanon | 5 |  |
| cxcmCanon_v1_1 | 6 |  |
| cxcmCanonComment_v1_1 | 7 |  |

**SignedPropertiesReferenceHashAlgorithm**: Specifies the hash algorithm used in SignedProperties reference.Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

**SignedPropertiesReferenceID**: Specifies the ID for Reference element that points to SignedProperties element.This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.

**SignedPropertiesReferenceInclusiveNamespacesPrefixList**: Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.

**SignedPropertiesReferenceIndex**: Specifies the index of SignedProperties reference.Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.

**SignedSignaturePropertiesID**: Specifies the ID for SignedSignatureProperties element.This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.

**SigningCertificatesChain**: Specifies which certificates from SigningChain are included in the xades:SigningCertificate element.Use this property to get or set the list of indices (relative to the SigningChain property) of the certificates to include in the xades:SigningCertificate element. The value may also be the keywords *none* (include none) or *all* (include the entire chain). The default is *all*.

**SigningCertificatesHashAlgorithm**: Specifies the hash algorithm used for SigningCertificates.Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

**SigningTimeFormat**: Specifies the date time format for the XAdES signing time.This property contains the date time format for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

Supported values:

|  |  |  |
| --- | --- | --- |
| YYYY |  | Year (e.g. 1997) |
| YYYY-MM |  | Year and month (e.g. 1997-07) |
| YYYY-MM-DD |  | Complete date (e.g. 1997-07-16) |
| YYYY-MM-DDThh:mmTZD |  | Complete date plus hours and minutes (e.g. 1997-07-16T19:20+01:00) |
| YYYY-MM-DDThh:mm:ssTZD |  | Complete date plus hours, minutes and seconds (e.g. 1997-07-16T20:20:30Z) |
| YYYY-MM-DDThh:mm:ss.sTZD |  | Complete date plus hours, minutes, seconds and a decimal fraction of a second (e.g. 1997-07-16T20:20:30.4Z) |
| YYYY-MM-DDThh:mm:ss.sssTZD |  | Default. Complete date plus hours, minutes, seconds and a fraction of a second (e.g. 1997-07-16T20:20:30.451Z) |

**SigningTimeIsUTC**: Specifies whether the XAdES signing time is in UTC.This property controls how the value provided by [NewSigClaimedSigningTime](#newsigclaimedsigningtime-property-secureblackbox_officesigner-class) is interpreted and serialized into the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

Behavior:

|  |  |  |
| --- | --- | --- |
| "true" |  | Default. The provided time is interpreted as UTC. If [SigningTimeZoneOffset](#SigningTimeZoneOffset) is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC. |
| "false" |  | The provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if [SigningTimeZoneOffset](#SigningTimeZoneOffset) is non-zero, the specified offset is included. |

**SigningTimeZoneOffset**: Specifies the time zone offset for the XAdES signing time.This property contains the time zone offset in minutes for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

**SignTime**: Specifies the signing time in UTC.Specifies the signing time in UTC. Used for Binary Crypto API signature.

**SigPolicyDescription**: signature policy description.This property specifies the Description of the signature policy (an alias for PolicyDescription).

**SigPolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

**SigPolicyHash**: The EPES policy hash.Use this configuration setting to provide the EPES policy hash.

**SigPolicyHashAlgorithm**: The hash algorithm that was used to generate the EPES policy hash.Use this setting to provide the hash algorithm that was used to generate the policy hash.

**SigPolicyID**: The EPES policy ID.The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

**SigPolicyNoticeNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

**SigPolicyNoticeOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

**SigPolicyURI**: The EPES policy URI.Assign the EPES policy URI to this setting.

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**TimestampCanonicalizationMethod**: Specifies canonicalization method used in timestamp.Use this property to specify the canonicalization method used in timestamp.

|  |  |  |
| --- | --- | --- |
| cxcmNone | 0 |  |
| cxcmCanon | 1 |  |
| cxcmCanonComment | 2 |  |
| cxcmExclCanon | 3 |  |
| cxcmExclCanonComment | 4 |  |
| cxcmMinCanon | 5 |  |
| cxcmCanon_v1_1 | 6 |  |
| cxcmCanonComment_v1_1 | 7 |  |

**TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [Notification](#notification-event-secureblackbox_officesigner-class) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).

**TimestampValidationDataDetails**: Specifies timestamp validation data details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.

Supported values are:

|  |  |  |
| --- | --- | --- |
| certificate |  | Base64-encoded [X509v3] certificates |
| crl |  | Base64-encoded certificate revocation lists (CRL) |
| ocsp |  | OCSP responses |

**TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.

**TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.

**TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the class may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

**TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.

**TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated

**TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the [Notification](#notification-event-secureblackbox_officesigner-class) event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

**TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration class uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

Note: Unlike other classes, [PDFSigner](PDFSigner.md#PDFSigner) class uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.

**TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

**UseDefaultTrustedLists**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

**UseDefaultTSLs**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

**UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

**UseHMACSigning**: Whether to use HMAC signing.Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.

**UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

**UsePSS**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations.

**UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

**UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.

**UseValidatorSettingsForTLSValidation**: Whether to employ the primary chain validator setup for auxiliary TLS chain validations.Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL).

**ValidationDataRefsDetails**: Specifies validation data references details to include to the signature.Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.

Supported values are:

|  |  |  |
| --- | --- | --- |
| certificate |  | References to X.509 certificates |
| crl |  | References to certificate revocation lists (CRL) |
| ocsp |  | References to OCSP responses |

**ValidationDataRefsHashAlgorithm**: Specifies the hash algorithm used in validation data references.Use this property to specify the hash algorithm used to compute hashes for validation data references.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| 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_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

**ValidationDataValuesDetails**: Specifies validation data values details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.

Supported values are:

|  |  |  |
| --- | --- | --- |
| certificate |  | Base64-encoded [X509v3] certificates |
| crl |  | Base64-encoded certificate revocation lists (CRL) |
| ocsp |  | OCSP responses |

**XAdESPrefix**: Specifies the XAdES prefix.Specifies the prefix for the XAdES elements.

Default value is "xades". In this case "xades:" prefix will be used.

Special values:

|  |  |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |

**XAdESv141Prefix**: Specifies the XAdES v1.4.1 prefix.Specifies the prefix for the XAdES v1.4.1 elements.

Default value is "xadesv141". In this case "xadesv141:" prefix will be used.

Special values:

|  |  |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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

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

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

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

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

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

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

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

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

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

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

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

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

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

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

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

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

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

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

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

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

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

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

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

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

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([OfficeSigner](#officesigner-class) Class)

### OfficeSigner Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |
| 24117249 | The input file does not exist ([SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS](constants.md#const_SBERROROFFICEINPUTFILENOTEXISTS)) |
| 24117250 | Unsupported document format ([SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT](constants.md#const_SBERROROFFICEUNSUPPORTEDDOCUMENTFORMAT)) |
| 24117251 | The document cannot be signed ([SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE](constants.md#const_SBERROROFFICEDOCUMENTNOTSIGNABLE)) |
| 24117253 | The document is already encrypted ([SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED](constants.md#const_SBERROROFFICEDOCUMENTENCRYPTED)) |
| 24117254 | The document cannot be encrypted ([SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE](constants.md#const_SBERROROFFICEDOCUMENTNOTENCRYPTABLE)) |
| 24117255 | The document is not encrypted ([SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED](constants.md#const_SBERROROFFICEDOCUMENTNOTENCRYPTED)) |
| 24117256 | Unsupported encryption type ([SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION](constants.md#const_SBERROROFFICEDOCUMENTUNKNOWNENCRYPTION)) |
| 24117257 | Invalid password ([SB_ERROR_OFFICE_INVALID_PASSWORD](constants.md#const_SBERROROFFICEINVALIDPASSWORD)) |
| 24117258 | No signature found to complete the asynchronous signing ([SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND](constants.md#const_SBERROROFFICESIGNATURENOTFOUND)) |