CAdESSigner Class

Properties   Methods   Events   Config Settings   Errors  

The CAdESSigner class creates CAdES- and CMS-compliant electronic signatures.

Class Name

SecureBlackbox_CAdESSigner

Procedural Interface

 secureblackbox_cadessigner_open();
 secureblackbox_cadessigner_close($res);
 secureblackbox_cadessigner_register_callback($res, $id, $function);
 secureblackbox_cadessigner_get_last_error($res);
 secureblackbox_cadessigner_get_last_error_code($res);
 secureblackbox_cadessigner_set($res, $id, $index, $value);
 secureblackbox_cadessigner_get($res, $id, $index);
 secureblackbox_cadessigner_do_addattribute($res, $oid, $value, $signedattribute);
 secureblackbox_cadessigner_do_archive($res, $siglabel, $baseline);
 secureblackbox_cadessigner_do_close($res, $savechanges);
 secureblackbox_cadessigner_do_config($res, $configurationstring);
 secureblackbox_cadessigner_do_createnew($res);
 secureblackbox_cadessigner_do_doaction($res, $actionid, $actionparams);
 secureblackbox_cadessigner_do_extractasyncdata($res, $asyncreply);
 secureblackbox_cadessigner_do_open($res);
 secureblackbox_cadessigner_do_reset($res);
 secureblackbox_cadessigner_do_revalidate($res, $siglabel);
 secureblackbox_cadessigner_do_selectinfo($res, $entitylabel, $infotype, $clearselection);
 secureblackbox_cadessigner_do_sign($res);
 secureblackbox_cadessigner_do_signasyncbegin($res);
 secureblackbox_cadessigner_do_signasyncend($res, $asyncreply);
 secureblackbox_cadessigner_do_signexternal($res);
 secureblackbox_cadessigner_do_timestamp($res, $siglabel, $timestamptype);
 secureblackbox_cadessigner_do_upgrade($res, $siglabel, $upgradekind);

Remarks

CAdESSigner can sign documents and files in compliance with CMS Advanced Electronic Signatures (CAdES) specification. Originally developed by ETSI on the basis of PKCS#7 format and initially adopted in the European Union, CAdES has quickly become a recognized international standard for signing all sorts of electronic documents. CAdESSigner signer = new CAdESSigner(); signer.getNewSignature().setHashAlgorithm("SHA512"); // Default hashing algorithm SHA256 signer.getNewSignature().setLevel(CAdESSignature.aslBaselineT); // Set the level of the signature // Select the file which will be signed signer.setInputFile("MyExe.exe"); // Set the path where the signed file will be saved signer.setOutputFile("signedFile.scs"); // Specify the certificate that shall be used for signing signer.setSigningCertificate(new Certificate("cert.pfx","password")); // Provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature signer.setTimestampServer("http://freetsa.org/tsr"); signer.sign(); // Sign

Besides being a signature standard in its own right, CAdES is used as part of other higher-level signature standards, such as PAdES or S/MIME. It provides a convenient framework for creating short-lived and long-term signatures over any kind of documents, and is now used by governments, healthcare providers, banks, and independent service providers all across the globe.

Standards and technologies supported

CAdESSigner offers the following signing capabilities:

• Create and upgrade CAdES signatures in accordance with the most recent CAdES specification (ETSI EN 319 122). Some features from older versions are also supported.
• All profiles are supported (BES, EPES, T, C, X, XL, A, including Baseline and Extended variants).
• Timestamping using external TSAs.
• All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).

Configuring the signature parameters

Configuring CAdESSigner to make it produce a signature of the right type is the main task you would need to perform in your code. Normally the service or software you will be communicating your signed documents to will provide you with the list of requirements that your signatures should match.

Typically, those will dictate the following key aspects of the signatures:

• The signature Level (such BES, T, XL, A, or XLong). This can be passed as the Level parameter of the Sign method.
• Whether the signature should be detached or enveloping: this can be adjusted via the Detached parameter of the Sign method.
• When creating a timestamped signature (such as T or A), provide the address of your online TSA service via TimestampServer property.
• When creating long-term signatures that include the signing chain and validation material, tune up validation parameters via RevocationCheck, OfflineMode, and IgnoreChainValidationErrors properties.

In some circumstances you will also need to adjust the following lower-level settings:

• Set ClaimedSigningTime to include the local signature creation time (not timestamped by a TTP).
• Specify EPES signature parameters via NewSigPolicyHash, NewSigPolicyHashAlgorithm, NewSigPolicyID, and NewSigPolicyURI properties.
• Provide the hash algorithm via the HashAlgorithm property.

Signing certificates

CAdESSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3) or in the cloud.

Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary interfaces can be plugged in with the external signing feature (see below).

You can use CertificateManager and CertificateStorage components to access the signing certificate. Assign the certificate to SigningCertificate property, and optionally provide the remainder of its chain via SigningChain property.

Note: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage component provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used.

You don't need to provide a signing certificate or chain when timestamping and upgrading signatures, since this type of operation does not involve the signing private key.

Signing a file

Now that you have set up all signature properties and attached the signing certificate, it is time to proceed to signing. You can provide the input document in one of the following forms: as a file (assign the path to InputFile property), as a stream (assign to InputStream property), or as a byte array (assign to InputBytes). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via OutputFile and OutputStream respectively, or by reading the resulting document bytes from the OutputBytes property after the signing completes.

Having set up the input and output (unless using OutputBytes, which should be read later), call the component's Sign method, passing the desired signature level and type as parameters. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. in CAdES-BES or B-B variant), or it may involve advanced chain validation routines (CAdES-XL or -A). During the latter the component may contact a number of external revocation information sources (CRL and OCSP servers) to establish the validity of the signing certificate.

If a TSA server was provided via the TimestampServer property, the component will contact it too to timestamp the new signature.

During the signing CAdESSigner may fire events to let your code know of certain conditions. It may fire TLSCertValidate if one of the HTTP endpoints involved in the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated.

Apart from signing, CAdESSigner can perform operations on signatures of other kinds. Use Upgrade method to upgrade an existing CAdES signature to a higher level (e.g. BES to XL). Use Timestamp to add a generic or validation timestamp to an existing signature. Use the Countersign method to add a countersignature to an existing signature. For any of these operations the input should constitute a valid CAdES signature.

External signing and DCAuth

CAdESSigner, like many other components offered by the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your usage scenario best.

Synchronous method: ExternalSign

This is a simpler method that basically lets you infiltrate into the heart of the signing routine by taking care of the hash signing operation. The component does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval).

To initiate this method, call SignExternal instead of Sign. When the hash is ready, it will be passed back to your code with ExternalSign event. Your event handler needs to sign the hash with the private key and return the created signature back to the component - which will embed it into the document.

You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is often included in the hash calculation.

This method is synchronous, meaning SignExternal provides you the results immediately upon its completion.

Asynchronous method: DCAuth

DCAuth is a SecureBlackbox-own know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:

• The signing party - such as CAdESSigner - initiates the operation using SignAsyncBegin call. This produces two outcomes: a pre-signed document (a document with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the CAdESSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page).
• The request state is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, response state, which contains the signature. The private key holder then sends the response state back to the signing party.
• The signing party re-creates the controls, and passes the response state, together with the pre-signed version of the document, to the signer's SignAsyncEnd method. SignAsyncEnd extracts the signature from the response state and incorporates it into the pre-signed document.

This method is asynchronous in that sense that, from the signing party's viewpoint, it splits the signing operation into the pre-signing and completion stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time.

Fine-grained chain validation setup

Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to tune up your chain validation parameters so they fit them best. A summary of such parameters is given below.

• RevocationCheck lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce.
• OfflineMode is a master switch that stops the class from looking for any validation tokens online. If this property is switched on, the class will only use the KnownCertificates, TrustedCertificates, KnownCRLs, and KnownOCSPs collections to look for the missing validation material.
• IgnoreChainValidationErrors makes the class ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted.
• KnownCertificates, KnownCRLs, and KnownOCSPs let you provide your own validation material. This may be useful when working in OfflineMode, where the signer has no access to the validation sources, or where the validation material has already been collected.
• TrustedCertificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it.
• BlockedCertificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid.

The following parameters are not directly related to chain validation, but may have an implicit effect on it.

• Proxy, SocketSettings, and TLSSettings let you tune up the connectivity and TLS options in accordance with local preferences.
• TLSClientChain lets you provide the client certificate and its chain for TLS client authentication.
• Subscribe to TLSCertValidate to validate any TLS certificates of the services involved in chain validation.

The results of the chain validation procedure, upon its completion, are published in the following properties:

• ChainValidationResult contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
• ChainValidationDetails provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.
• ValidationLog contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AutoValidateSignatures Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getAutoValidateSignatures();


public function setAutoValidateSignatures($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 1 );


secureblackbox_cadessigner_set($res, 1, $value );

Default Value

false

Remarks

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

Data Type

Boolean

BlockedCertCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 2 );


secureblackbox_cadessigner_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 3 , $blockedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 11 , $blockedcertindex);


secureblackbox_cadessigner_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

CertCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 42 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertCA
• CertCAKeyID
• CertCertType
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertOCSPNoCheck
• CertOrigin
• CertPolicyIDs
• CertPrivateKeyBytes
• CertPrivateKeyExists
• CertPrivateKeyExtractable
• CertPublicKeyBytes
• CertQualified
• CertQualifiedStatements
• CertQualifiers
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSource
• CertSubject
• CertSubjectAlternativeName
• CertSubjectKeyID
• CertSubjectRDN
• CertValid
• CertValidFrom
• CertValidTo

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

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

Data Type

Integer

CertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CertCA Property (SecureBlackbox_CAdESSigner Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertCAKeyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_cadessigner_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 generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CertSubjectKeyID 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 property.

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

Data Type

Byte Array

CertCertType Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertCertType($certindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 46 , $certindex);

Default Value

0

Remarks

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

A 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 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 property.

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

Data Type

Integer

CertCRLDistributionPoints Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertCRLDistributionPoints($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertCurve Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

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

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

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

Data Type

String

CertFingerprint Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertFriendlyName Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertHandle($certindex);

Procedural Interface

secureblackbox_cadessigner_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

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

Data Type

Long64

CertHashAlgorithm Property (SecureBlackbox_CAdESSigner 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

public function getCertHashAlgorithm($certindex);

Procedural Interface

secureblackbox_cadessigner_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 to find out the hash algorithm that is part of the certificate signature.

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

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

Data Type

String

CertIssuer Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

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

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

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

Data Type

String

CertIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertKeyAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 55 , $certindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the CertKeyBits, CertCurve, and CertPublicKeyBytes 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 property.

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

Data Type

String

CertKeyBits Property (SecureBlackbox_CAdESSigner Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_cadessigner_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 or CertPrivateKeyBytes 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 property.

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

Data Type

Integer

CertKeyFingerprint Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property. The key fingeprint 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 property.

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

Data Type

String

CertKeyUsage Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertKeyUsage($certindex);

Procedural Interface

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

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

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

Data Type

Integer

CertKeyValid Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertOCSPLocations Property (SecureBlackbox_CAdESSigner 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

public function getCertOCSPLocations($certindex);

Procedural Interface

secureblackbox_cadessigner_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 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 property.

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

Data Type

String

CertOCSPNoCheck Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertOCSPNoCheck($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertOrigin Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertOrigin($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Integer

CertPolicyIDs Property (SecureBlackbox_CAdESSigner Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertPrivateKeyBytes Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertPrivateKeyBytes($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CertPrivateKeyExists Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertPrivateKeyExists($certindex);

Procedural Interface

secureblackbox_cadessigner_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, 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 property.

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

Data Type

Boolean

CertPrivateKeyExtractable Property (SecureBlackbox_CAdESSigner Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCertPrivateKeyExtractable($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertPublicKeyBytes Property (SecureBlackbox_CAdESSigner Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CertQualified Property (SecureBlackbox_CAdESSigner Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCertQualified($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertQualifiedStatements Property (SecureBlackbox_CAdESSigner Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements($certindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 69 , $certindex);

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

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

Data Type

Integer

CertQualifiers Property (SecureBlackbox_CAdESSigner Class)

A list of qualifiers.

Object Oriented Interface

public function getCertQualifiers($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertSelfSigned Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSelfSigned($certindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 71 , $certindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CertSerialNumber Property (SecureBlackbox_CAdESSigner Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CertSigAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertSource Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSource($certindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 74 , $certindex);

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

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

Data Type

Integer

CertSubject Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSubject($certindex);

Procedural Interface

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

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

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

Data Type

String

CertSubjectAlternativeName Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSubjectAlternativeName($certindex);

Procedural Interface

secureblackbox_cadessigner_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 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 property.

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

Data Type

String

CertSubjectKeyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_cadessigner_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 and CertCAKeyID 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 property.

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

Data Type

Byte Array

CertSubjectRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertValid Property (SecureBlackbox_CAdESSigner 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

public function getCertValid($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

CertValidFrom Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CertValidTo Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CheckTrustedLists Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCheckTrustedLists();


public function setCheckTrustedLists($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 82 );


secureblackbox_cadessigner_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_CAdESSigner Class)

The number of records in the CRL arrays.

Object Oriented Interface

public function getCRLCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 83 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CRLBytes
• CRLCAKeyID
• CRLEntryCount
• CRLHandle
• CRLIssuer
• CRLIssuerRDN
• CRLLocation
• CRLNextUpdate
• CRLSigAlgorithm
• CRLSource
• CRLTBS
• CRLThisUpdate

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

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

Data Type

Integer

CRLBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getCRLBytes($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CRLCAKeyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLCAKeyID($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CRLEntryCount Property (SecureBlackbox_CAdESSigner Class)

Returns the number of certificate status entries in the CRL.

Object Oriented Interface

public function getCRLEntryCount($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Integer

CRLHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLHandle($crlindex);

Procedural Interface

secureblackbox_cadessigner_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

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

Data Type

Long64

CRLIssuer Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLIssuer($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CRLIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLIssuerRDN($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CRLLocation Property (SecureBlackbox_CAdESSigner Class)

The URL that the CRL was downloaded from.

Object Oriented Interface

public function getCRLLocation($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CRLNextUpdate Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLNextUpdate($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CRLSigAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLSigAlgorithm($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

CRLSource Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLSource($crlindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 93 , $crlindex);

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

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

Data Type

Integer

CRLTBS Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLTBS($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

CRLThisUpdate Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getCRLThisUpdate($crlindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

DataBytes Property (SecureBlackbox_CAdESSigner Class)

A byte array containing the external data source.

Object Oriented Interface

public function getDataBytes();


public function setDataBytes($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 96 );


secureblackbox_cadessigner_set($res, 96, $value );

Remarks

Use this property to provide external data source for detached signatures in the form of a byte array.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_CAdESSigner Class)

A path to a file containing an external data source.

Object Oriented Interface

public function getDataFile();


public function setDataFile($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 97 );


secureblackbox_cadessigner_set($res, 97, $value );

Default Value

''

Remarks

Use this property to provide an external data source for detached signatures. This property should only be assigned when countersigning or timestamping existing detached signatures. In this case the detached signature should be provided via InputFile, and the corresponding detached data via this property.

Data Type

String

DataIsHash Property (SecureBlackbox_CAdESSigner Class)

Specifies whether the data source contains the hash of the data or the actual data.

Object Oriented Interface

public function getDataIsHash();


public function setDataIsHash($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 98 );


secureblackbox_cadessigner_set($res, 98, $value );

Default Value

false

Remarks

Use this property to tell the component whether the data source contains the actual data or its hash.

This property is not available at design time.

Data Type

Boolean

Detached Property (SecureBlackbox_CAdESSigner Class)

Specifies whether a detached signature should be produced or verified.

Object Oriented Interface

public function getDetached();


public function setDetached($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 99 );


secureblackbox_cadessigner_set($res, 99, $value );

Default Value

false

Remarks

Use this property to specify whether a detached signature should be produced or verified.

When this property is set to "true" value, the data will be detached from the signature.

If this property is set to "true" value, the user must provide the detached content via the DataFile or DataStream or DataBytes properties.

When Detached is set to "false" value, the data is included with the signature.

Data Type

Boolean

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 100 );


secureblackbox_cadessigner_set($res, 100, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 101 );


secureblackbox_cadessigner_set($res, 101, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 102 );


secureblackbox_cadessigner_set($res, 102, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 103 );


secureblackbox_cadessigner_set($res, 103, $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_CAdESSigner Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 104 );


secureblackbox_cadessigner_set($res, 104, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 105 );


secureblackbox_cadessigner_set($res, 105, $value );

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_CAdESSigner Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 106 );


secureblackbox_cadessigner_set($res, 106, $value );

Default Value

''

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_CAdESSigner Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 107 );


secureblackbox_cadessigner_set($res, 107, $value );

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_CAdESSigner Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 108 );


secureblackbox_cadessigner_set($res, 108, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 109 );


secureblackbox_cadessigner_set($res, 109, $value );

Default Value

''

Remarks

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

Data Type

String

ExtractContent Property (SecureBlackbox_CAdESSigner Class)

Specifies whether a message content should be extracted.

Object Oriented Interface

public function getExtractContent();


public function setExtractContent($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 110 );


secureblackbox_cadessigner_set($res, 110, $value );

Default Value

false

Remarks

Use this property to specify whether a message content should be extracted when a signature is loaded. This applies only to non-detached signatures with embedded data.

When this property is set to "true" value, the message content will be extracted from the signature.

The user must provide the OutputFile or OutputStream properties with a filename or stream where to save the message content, if none is provided then message content is returned via OutputBytes property.

Data Type

Boolean

FIPSMode Property (SecureBlackbox_CAdESSigner Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 111 );


secureblackbox_cadessigner_set($res, 111, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

IgnoreChainValidationErrors Property (SecureBlackbox_CAdESSigner Class)

Makes the class tolerant to chain validation errors.

Object Oriented Interface

public function getIgnoreChainValidationErrors();


public function setIgnoreChainValidationErrors($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 112 );


secureblackbox_cadessigner_set($res, 112, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 113 );


secureblackbox_cadessigner_set($res, 113, $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_CAdESSigner Class)

A path to a file containing the data to be signed or updated.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 114 );


secureblackbox_cadessigner_set($res, 114, $value );

Default Value

''

Remarks

Use this property to provide the data to work on. In case of the first-time signing, point this property to your data file. If countersigning, upgrading, or timestamping an existing signature, provide your existing signature file.

If updating a detached signature, you might need to provide the original data via DataFile property.

The data provided via this property can alternatively be provided from memory via InputStream property.

Data Type

String

KnownCertCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 115 );


secureblackbox_cadessigner_set($res, 115, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 116 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 124 , $knowncertindex);


secureblackbox_cadessigner_set($res, 124, $value , $knowncertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 155 );


secureblackbox_cadessigner_set($res, 155, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 156 , $knowncrlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 159 , $knowncrlindex);


secureblackbox_cadessigner_set($res, 159, $value , $knowncrlindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 168 );


secureblackbox_cadessigner_set($res, 168, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_CAdESSigner Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 169 , $knownocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 171 , $knownocspindex);


secureblackbox_cadessigner_set($res, 171, $value , $knownocspindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

NewSigChainValidationDetails Property (SecureBlackbox_CAdESSigner Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getNewSigChainValidationDetails();

Procedural Interface

secureblackbox_cadessigner_get($res, 178 );

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

NewSigChainValidationResult Property (SecureBlackbox_CAdESSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getNewSigChainValidationResult();

Procedural Interface

secureblackbox_cadessigner_get($res, 179 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

NewSigClaimedSigningTime Property (SecureBlackbox_CAdESSigner Class)

The signing time from the signer's computer.

Object Oriented Interface

public function getNewSigClaimedSigningTime();


public function setNewSigClaimedSigningTime($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 180 );


secureblackbox_cadessigner_set($res, 180, $value );

Default Value

''

Remarks

The signing time from the signer's computer.

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

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

This property is not available at design time.

Data Type

String

NewSigCompatibilityErrors Property (SecureBlackbox_CAdESSigner Class)

Returns compatibility errors encountered during validation.

Object Oriented Interface

public function getNewSigCompatibilityErrors();

Procedural Interface

secureblackbox_cadessigner_get($res, 181 );

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.

Supported values:

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

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

Data Type

Integer

NewSigContainsLongTermInfo Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigContainsLongTermInfo();

Procedural Interface

secureblackbox_cadessigner_get($res, 182 );

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

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

Data Type

Boolean

NewSigContentType Property (SecureBlackbox_CAdESSigner Class)

The signature content type.

Object Oriented Interface

public function getNewSigContentType();


public function setNewSigContentType($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 183 );


secureblackbox_cadessigner_set($res, 183, $value );

Default Value

''

Remarks

The signature content type.

Use this property to check the content type attribute of the message record in it by the signer.

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

This property is not available at design time.

Data Type

String

NewSigCountersigned Property (SecureBlackbox_CAdESSigner Class)

Indicates if the signature is countersigned.

Object Oriented Interface

public function getNewSigCountersigned();

Procedural Interface

secureblackbox_cadessigner_get($res, 184 );

Default Value

false

Remarks

Indicates if the signature is countersigned.

Use this property to find out whether the signed message contains any countersignatures over the main signature(s).

You can track countersignatures during the validating by subscribing to SignatureValidated event.

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

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

Data Type

Boolean

NewSigEntityLabel Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the signature entity label.

Object Oriented Interface

public function getNewSigEntityLabel();

Procedural Interface

secureblackbox_cadessigner_get($res, 185 );

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

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

Data Type

String

NewSigHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigHandle();


public function setNewSigHandle($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 186 );


secureblackbox_cadessigner_set($res, 186, $value );

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

NewSigHashAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Set or returns the hash algorithm used to generate the signature.

Object Oriented Interface

public function getNewSigHashAlgorithm();


public function setNewSigHashAlgorithm($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 187 );


secureblackbox_cadessigner_set($res, 187, $value );

Default Value

''

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.

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

This property is not available at design time.

Data Type

String

NewSigIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigIssuerRDN();

Procedural Interface

secureblackbox_cadessigner_get($res, 188 );

Default Value

''

Remarks

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

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

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

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

Data Type

String

NewSigLastArchivalTime Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigLastArchivalTime();

Procedural Interface

secureblackbox_cadessigner_get($res, 189 );

Default Value

''

Remarks

Indicates the most recent archival time of an archived signature

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

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

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

Data Type

String

NewSigLevel Property (SecureBlackbox_CAdESSigner Class)

Specifies the CAdES signature level.

Object Oriented Interface

public function getNewSigLevel();


public function setNewSigLevel($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 190 );


secureblackbox_cadessigner_set($res, 190, $value );

Default Value

2

Remarks

Specifies the CAdES signature level.

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes.

The supported levels are:

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

This property is not available at design time.

Data Type

Integer

NewSigMessageDigest Property (SecureBlackbox_CAdESSigner Class)

The binary of the signature's message digest.

Object Oriented Interface

public function getNewSigMessageDigest();

Procedural Interface

secureblackbox_cadessigner_get($res, 191 );

Default Value

''

Remarks

The binary of the signature's message digest.

Use this property to access the 'main' message digest of the CMS blob (the digest included as a message-digest signed attribute).

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

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

Data Type

String

NewSigParentEntity Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the parent signature label.

Object Oriented Interface

public function getNewSigParentEntity();


public function setNewSigParentEntity($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 192 );


secureblackbox_cadessigner_set($res, 192, $value );

Default Value

''

Remarks

Use this property to get the parent signature label.

This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.

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

This property is not available at design time.

Data Type

String

NewSigPolicyHash Property (SecureBlackbox_CAdESSigner Class)

The signature policy hash value.

Object Oriented Interface

public function getNewSigPolicyHash();


public function setNewSigPolicyHash($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 193 );


secureblackbox_cadessigner_set($res, 193, $value );

Default Value

''

Remarks

The signature policy hash value.

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

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

This property is not available at design time.

Data Type

String

NewSigPolicyHashAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigPolicyHashAlgorithm();


public function setNewSigPolicyHashAlgorithm($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 194 );


secureblackbox_cadessigner_set($res, 194, $value );

Default Value

''

Remarks

The algorithm that was used to calculate the signature policy hash

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

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

This property is not available at design time.

Data Type

String

NewSigPolicyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigPolicyID();


public function setNewSigPolicyID($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 195 );


secureblackbox_cadessigner_set($res, 195, $value );

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

NewSigPolicyURI Property (SecureBlackbox_CAdESSigner Class)

The signature policy URI that was included in the signature.

Object Oriented Interface

public function getNewSigPolicyURI();


public function setNewSigPolicyURI($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 196 );


secureblackbox_cadessigner_set($res, 196, $value );

Default Value

''

Remarks

The signature policy URI that was included in the signature.

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

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

This property is not available at design time.

Data Type

String

NewSigPublicKeyAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Returns the public key algorithm that was used to create the signature.

Object Oriented Interface

public function getNewSigPublicKeyAlgorithm();

Procedural Interface

secureblackbox_cadessigner_get($res, 197 );

Default Value

''

Remarks

Returns the public key algorithm that was used to create the signature.

This property specifies the public key algorithm that was used to create the signature. This typically matches the algorithm 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 property.

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

Data Type

String

NewSigScope Property (SecureBlackbox_CAdESSigner Class)

Returns the type of the entity that this signature corresponds to.

Object Oriented Interface

public function getNewSigScope();

Procedural Interface

secureblackbox_cadessigner_get($res, 198 );

Default Value

0

Remarks

Returns the type of the entity that this signature corresponds to.

A CAdES signature may cover several kinds of entities: the signed data itself (a top-level signature - something you create when you sign documents), a timestamp, or a countersignature.

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

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

Data Type

Integer

NewSigSerialNumber Property (SecureBlackbox_CAdESSigner Class)

The serial number of the signing certificate.

Object Oriented Interface

public function getNewSigSerialNumber();

Procedural Interface

secureblackbox_cadessigner_get($res, 199 );

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

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

Data Type

Byte Array

NewSigSignatureBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the binary representation of the CAdES signature.

Object Oriented Interface

public function getNewSigSignatureBytes();

Procedural Interface

secureblackbox_cadessigner_get($res, 200 );

Remarks

Returns the binary representation of the CAdES signature.

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

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

Data Type

Byte Array

NewSigSignatureValidationResult Property (SecureBlackbox_CAdESSigner Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getNewSigSignatureValidationResult();

Procedural Interface

secureblackbox_cadessigner_get($res, 201 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

NewSigSubjectKeyID Property (SecureBlackbox_CAdESSigner Class)

Contains the subject key identifier of the signing certificate.

Object Oriented Interface

public function getNewSigSubjectKeyID();

Procedural Interface

secureblackbox_cadessigner_get($res, 202 );

Remarks

Contains the subject key identifier of the signing certificate.

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

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

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

Data Type

Byte Array

NewSigSubjectRDN Property (SecureBlackbox_CAdESSigner Class)

Contains the RDN of the owner of the signing certificate.

Object Oriented Interface

public function getNewSigSubjectRDN();

Procedural Interface

secureblackbox_cadessigner_get($res, 203 );

Default Value

''

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.

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

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

Data Type

String

NewSigTimestamped Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getNewSigTimestamped();

Procedural Interface

secureblackbox_cadessigner_get($res, 204 );

Default Value

false

Remarks

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

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

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

Data Type

Boolean

NewSigValidatedSigningTime Property (SecureBlackbox_CAdESSigner Class)

Contains the certified signing time.

Object Oriented Interface

public function getNewSigValidatedSigningTime();

Procedural Interface

secureblackbox_cadessigner_get($res, 205 );

Default Value

''

Remarks

Contains the certified signing time.

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

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

Both times are in UTC.

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

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

Data Type

String

NewSigValidationLog Property (SecureBlackbox_CAdESSigner Class)

Contains the signing certificate's chain validation log.

Object Oriented Interface

public function getNewSigValidationLog();

Procedural Interface

secureblackbox_cadessigner_get($res, 206 );

Default Value

''

Remarks

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

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

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

Data Type

String

OCSPCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the OCSP arrays.

Object Oriented Interface

public function getOCSPCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 207 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OCSPBytes
• OCSPEntryCount
• OCSPHandle
• OCSPIssuer
• OCSPIssuerRDN
• OCSPLocation
• OCSPProducedAt
• OCSPSigAlgorithm
• OCSPSource

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

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getOCSPBytes($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 208 , $ocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

OCSPEntryCount Property (SecureBlackbox_CAdESSigner Class)

The number of SingleResponse elements contained in this OCSP response.

Object Oriented Interface

public function getOCSPEntryCount($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 209 , $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 property.

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

Data Type

Integer

OCSPHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPHandle($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 210 , $ocspindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

OCSPIssuer Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPIssuer($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 211 , $ocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

OCSPIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPIssuerRDN($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 212 , $ocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

OCSPLocation Property (SecureBlackbox_CAdESSigner Class)

The location of the OCSP responder.

Object Oriented Interface

public function getOCSPLocation($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 213 , $ocspindex);

Default Value

''

Remarks

The location of the OCSP responder.

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

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

Data Type

String

OCSPProducedAt Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPProducedAt($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 214 , $ocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

OCSPSigAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPSigAlgorithm($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 215 , $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 property.

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

Data Type

String

OCSPSource Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getOCSPSource($ocspindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 216 , $ocspindex);

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

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

Data Type

Integer

OfflineMode Property (SecureBlackbox_CAdESSigner Class)

Switches the class to offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 217 );


secureblackbox_cadessigner_set($res, 217, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_cadessigner_get($res, 218 );

Remarks

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

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_CAdESSigner Class)

A file where the signed data is to be saved.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 219 );


secureblackbox_cadessigner_set($res, 219, $value );

Default Value

''

Remarks

Use this property to provide a path to the file where to save the resulting signed message.

Data Type

String

Profile Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 220 );


secureblackbox_cadessigner_set($res, 220, $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_CAdESSigner Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 221 );


secureblackbox_cadessigner_set($res, 221, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_CAdESSigner Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 222 );


secureblackbox_cadessigner_set($res, 222, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_CAdESSigner Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 223 );


secureblackbox_cadessigner_set($res, 223, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_CAdESSigner Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 224 );


secureblackbox_cadessigner_set($res, 224, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_CAdESSigner Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 225 );


secureblackbox_cadessigner_set($res, 225, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_CAdESSigner Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 226 );


secureblackbox_cadessigner_set($res, 226, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 227 );


secureblackbox_cadessigner_set($res, 227, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 228 );


secureblackbox_cadessigner_set($res, 228, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 229 );


secureblackbox_cadessigner_set($res, 229, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_CAdESSigner Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 230 );


secureblackbox_cadessigner_set($res, 230, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RevocationCheck Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 231 );


secureblackbox_cadessigner_set($res, 231, $value );

Default Value

1

Remarks

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

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

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

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

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

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

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

Data Type

Integer

SignatureCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the Signature arrays.

Object Oriented Interface

public function getSignatureCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 232 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureChainValidationDetails
• SignatureChainValidationResult
• SignatureClaimedSigningTime
• SignatureCompatibilityErrors
• SignatureContainsLongTermInfo
• SignatureContentType
• SignatureCountersigned
• SignatureEntityLabel
• SignatureHandle
• SignatureHashAlgorithm
• SignatureIssuerRDN
• SignatureLastArchivalTime
• SignatureLevel
• SignatureMessageDigest
• SignatureParentEntity
• SignaturePolicyHash
• SignaturePolicyHashAlgorithm
• SignaturePolicyID
• SignaturePolicyURI
• SignaturePublicKeyAlgorithm
• SignatureScope
• SignatureSerialNumber
• SignatureSignatureBytes
• SignatureSignatureValidationResult
• SignatureSubjectKeyID
• SignatureSubjectRDN
• SignatureTimestamped
• SignatureValidatedSigningTime
• SignatureValidationLog

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

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getSignatureChainValidationDetails($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 233 , $signatureindex);

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

SignatureChainValidationResult Property (SecureBlackbox_CAdESSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getSignatureChainValidationResult($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 234 , $signatureindex);

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

SignatureClaimedSigningTime Property (SecureBlackbox_CAdESSigner Class)

The signing time from the signer's computer.

Object Oriented Interface

public function getSignatureClaimedSigningTime($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 235 , $signatureindex);

Default Value

''

Remarks

The signing time from the signer's computer.

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

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

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

Data Type

String

SignatureCompatibilityErrors Property (SecureBlackbox_CAdESSigner Class)

Returns compatibility errors encountered during validation.

Object Oriented Interface

public function getSignatureCompatibilityErrors($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 236 , $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.

Supported values:

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

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

Data Type

Integer

SignatureContainsLongTermInfo Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignatureContainsLongTermInfo($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 237 , $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 property.

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

Data Type

Boolean

SignatureContentType Property (SecureBlackbox_CAdESSigner Class)

The signature content type.

Object Oriented Interface

public function getSignatureContentType($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 238 , $signatureindex);

Default Value

''

Remarks

The signature content type.

Use this property to check the content type attribute of the message record in it by the signer.

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

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

Data Type

String

SignatureCountersigned Property (SecureBlackbox_CAdESSigner Class)

Indicates if the signature is countersigned.

Object Oriented Interface

public function getSignatureCountersigned($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 239 , $signatureindex);

Default Value

false

Remarks

Indicates if the signature is countersigned.

Use this property to find out whether the signed message contains any countersignatures over the main signature(s).

You can track countersignatures during the validating by subscribing to SignatureValidated event.

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

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

Data Type

Boolean

SignatureEntityLabel Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the signature entity label.

Object Oriented Interface

public function getSignatureEntityLabel($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 240 , $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 property.

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

Data Type

String

SignatureHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignatureHandle($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

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

Data Type

Long64

SignatureHashAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Set or returns the hash algorithm used to generate the signature.

Object Oriented Interface

public function getSignatureHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 242 , $signatureindex);

Default Value

''

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.

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

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

Data Type

String

SignatureIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignatureIssuerRDN($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

SignatureLastArchivalTime Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignatureLastArchivalTime($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

String

SignatureLevel Property (SecureBlackbox_CAdESSigner Class)

Specifies the CAdES signature level.

Object Oriented Interface

public function getSignatureLevel($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 245 , $signatureindex);

Default Value

2

Remarks

Specifies the CAdES signature level.

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes.

The supported levels are:

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

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

Data Type

Integer

SignatureMessageDigest Property (SecureBlackbox_CAdESSigner Class)

The binary of the signature's message digest.

Object Oriented Interface

public function getSignatureMessageDigest($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 246 , $signatureindex);

Default Value

''

Remarks

The binary of the signature's message digest.

Use this property to access the 'main' message digest of the CMS blob (the digest included as a message-digest signed attribute).

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

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

Data Type

String

SignatureParentEntity Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the parent signature label.

Object Oriented Interface

public function getSignatureParentEntity($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 247 , $signatureindex);

Default Value

''

Remarks

Use this property to get the parent signature label.

This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.

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

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

Data Type

String

SignaturePolicyHash Property (SecureBlackbox_CAdESSigner Class)

The signature policy hash value.

Object Oriented Interface

public function getSignaturePolicyHash($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 248 , $signatureindex);

Default Value

''

Remarks

The signature policy hash value.

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

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

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

Data Type

String

SignaturePolicyHashAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignaturePolicyHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 249 , $signatureindex);

Default Value

''

Remarks

The algorithm that was used to calculate the signature policy hash

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

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

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

Data Type

String

SignaturePolicyID Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignaturePolicyID($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 250 , $signatureindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

SignaturePolicyURI Property (SecureBlackbox_CAdESSigner Class)

The signature policy URI that was included in the signature.

Object Oriented Interface

public function getSignaturePolicyURI($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 251 , $signatureindex);

Default Value

''

Remarks

The signature policy URI that was included in the signature.

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

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

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

Data Type

String

SignaturePublicKeyAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Returns the public key algorithm that was used to create the signature.

Object Oriented Interface

public function getSignaturePublicKeyAlgorithm($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 252 , $signatureindex);

Default Value

''

Remarks

Returns the public key algorithm that was used to create the signature.

This property specifies the public key algorithm that was used to create the signature. This typically matches the algorithm 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 property.

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

Data Type

String

SignatureScope Property (SecureBlackbox_CAdESSigner Class)

Returns the type of the entity that this signature corresponds to.

Object Oriented Interface

public function getSignatureScope($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 253 , $signatureindex);

Default Value

0

Remarks

Returns the type of the entity that this signature corresponds to.

A CAdES signature may cover several kinds of entities: the signed data itself (a top-level signature - something you create when you sign documents), a timestamp, or a countersignature.

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

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

Data Type

Integer

SignatureSerialNumber Property (SecureBlackbox_CAdESSigner Class)

The serial number of the signing certificate.

Object Oriented Interface

public function getSignatureSerialNumber($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 254 , $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 property.

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

Data Type

Byte Array

SignatureSignatureBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the binary representation of the CAdES signature.

Object Oriented Interface

public function getSignatureSignatureBytes($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 255 , $signatureindex);

Remarks

Returns the binary representation of the CAdES signature.

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

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

Data Type

Byte Array

SignatureSignatureValidationResult Property (SecureBlackbox_CAdESSigner Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSignatureSignatureValidationResult($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 256 , $signatureindex);

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

SignatureSubjectKeyID Property (SecureBlackbox_CAdESSigner Class)

Contains the subject key identifier of the signing certificate.

Object Oriented Interface

public function getSignatureSubjectKeyID($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Byte Array

SignatureSubjectRDN Property (SecureBlackbox_CAdESSigner Class)

Contains the RDN of the owner of the signing certificate.

Object Oriented Interface

public function getSignatureSubjectRDN($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 258 , $signatureindex);

Default Value

''

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.

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

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

Data Type

String

SignatureTimestamped Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSignatureTimestamped($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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 property.

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

Data Type

Boolean

SignatureValidatedSigningTime Property (SecureBlackbox_CAdESSigner Class)

Contains the certified signing time.

Object Oriented Interface

public function getSignatureValidatedSigningTime($signatureindex);

Procedural Interface

secureblackbox_cadessigner_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 returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

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

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

Data Type

String

SignatureValidationLog Property (SecureBlackbox_CAdESSigner Class)

Contains the signing certificate's chain validation log.

Object Oriented Interface

public function getSignatureValidationLog($signatureindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 261 , $signatureindex);

Default Value

''

Remarks

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

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

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

Data Type

String

SignedAttributeCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the SignedAttribute arrays.

Object Oriented Interface

public function getSignedAttributeCount();


public function setSignedAttributeCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 262 );


secureblackbox_cadessigner_set($res, 262, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignedAttributeOID
• SignedAttributeValue

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

This property is not available at design time.

Data Type

Integer

SignedAttributeOID Property (SecureBlackbox_CAdESSigner Class)

The object identifier of the attribute.

Object Oriented Interface

public function getSignedAttributeOID($signedattributeindex);


public function setSignedAttributeOID($signedattributeindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 263 , $signedattributeindex);


secureblackbox_cadessigner_set($res, 263, $value , $signedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

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

This property is not available at design time.

Data Type

String

SignedAttributeValue Property (SecureBlackbox_CAdESSigner Class)

The value of the attribute.

Object Oriented Interface

public function getSignedAttributeValue($signedattributeindex);


public function setSignedAttributeValue($signedattributeindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 264 , $signedattributeindex);


secureblackbox_cadessigner_set($res, 264, $value , $signedattributeindex);

Remarks

The value of the attribute.

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

This property is not available at design time.

Data Type

Byte Array

SigningCertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_cadessigner_get($res, 265 );

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

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

Object Oriented Interface

public function getSigningCertHandle();


public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 273 );


secureblackbox_cadessigner_set($res, 273, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 304 );


secureblackbox_cadessigner_set($res, 304, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 305 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 313 , $signingchainindex);


secureblackbox_cadessigner_set($res, 313, $value , $signingchainindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

SocketDNSMode Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 344 );


secureblackbox_cadessigner_set($res, 344, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 345 );


secureblackbox_cadessigner_set($res, 345, $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_CAdESSigner Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 346 );


secureblackbox_cadessigner_set($res, 346, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 347 );


secureblackbox_cadessigner_set($res, 347, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 348 );


secureblackbox_cadessigner_set($res, 348, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 349 );


secureblackbox_cadessigner_set($res, 349, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_CAdESSigner Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 350 );


secureblackbox_cadessigner_set($res, 350, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_CAdESSigner Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 351 );


secureblackbox_cadessigner_set($res, 351, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 352 );


secureblackbox_cadessigner_set($res, 352, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 353 );


secureblackbox_cadessigner_set($res, 353, $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_CAdESSigner Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 354 );


secureblackbox_cadessigner_set($res, 354, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TimestampCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the Timestamp arrays.

Object Oriented Interface

public function getTimestampCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 355 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TimestampAccuracy
• TimestampBytes
• TimestampCertificateIndex
• TimestampChainValidationDetails
• TimestampChainValidationResult
• TimestampContainsLongTermInfo
• TimestampEntityLabel
• TimestampHashAlgorithm
• TimestampParentEntity
• TimestampSerialNumber
• TimestampTime
• TimestampTimestampType
• TimestampTSAName
• TimestampValidationLog
• TimestampValidationResult

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

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

Data Type

Integer

TimestampAccuracy Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTimestampAccuracy($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 356 , $timestampindex);

Default Value

0

Remarks

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

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

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

Data Type

Long64

TimestampBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw timestamp data in DER format.

Object Oriented Interface

public function getTimestampBytes($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 357 , $timestampindex);

Remarks

Returns the raw timestamp data in DER format.

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

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

Data Type

Byte Array

TimestampCertificateIndex Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTimestampCertificateIndex($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 358 , $timestampindex);

Default Value

-1

Remarks

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

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

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

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

Data Type

Integer

TimestampChainValidationDetails Property (SecureBlackbox_CAdESSigner Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getTimestampChainValidationDetails($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 359 , $timestampindex);

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

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

Data Type

Integer

TimestampChainValidationResult Property (SecureBlackbox_CAdESSigner Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getTimestampChainValidationResult($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 360 , $timestampindex);

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

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

Data Type

Integer

TimestampContainsLongTermInfo Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTimestampContainsLongTermInfo($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 361 , $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 property.

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

Data Type

Boolean

TimestampEntityLabel Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the timestamp entity label.

Object Oriented Interface

public function getTimestampEntityLabel($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 362 , $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 property.

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

Data Type

String

TimestampHashAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Returns the timestamp's hash algorithm.

Object Oriented Interface

public function getTimestampHashAlgorithm($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 363 , $timestampindex);

Default Value

''

Remarks

Returns the timestamp's hash algorithm.

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

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

Data Type

String

TimestampParentEntity Property (SecureBlackbox_CAdESSigner Class)

Use this property to get the label of the timestamp's parent entity.

Object Oriented Interface

public function getTimestampParentEntity($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 364 , $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 property.

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

Data Type

String

TimestampSerialNumber Property (SecureBlackbox_CAdESSigner Class)

Returns the timestamp's serial number.

Object Oriented Interface

public function getTimestampSerialNumber($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 365 , $timestampindex);

Remarks

Returns the timestamp's serial number.

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

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

Data Type

Byte Array

TimestampTime Property (SecureBlackbox_CAdESSigner Class)

The time point incorporated into the timestamp.

Object Oriented Interface

public function getTimestampTime($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 366 , $timestampindex);

Default Value

''

Remarks

The time point incorporated into the timestamp.

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

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

Data Type

String

TimestampTimestampType Property (SecureBlackbox_CAdESSigner Class)

Returns the type of the timestamp.

Object Oriented Interface

public function getTimestampTimestampType($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 367 , $timestampindex);

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

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

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

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

Data Type

Integer

TimestampTSAName Property (SecureBlackbox_CAdESSigner Class)

This value uniquely identifies the Timestamp Authority (TSA).

Object Oriented Interface

public function getTimestampTSAName($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 368 , $timestampindex);

Default Value

''

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

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

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

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

Data Type

String

TimestampValidationLog Property (SecureBlackbox_CAdESSigner Class)

Contains the TSA certificate chain validation log.

Object Oriented Interface

public function getTimestampValidationLog($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 369 , $timestampindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TimestampValidationResult Property (SecureBlackbox_CAdESSigner Class)

Contains the timestamp validation outcome.

Object Oriented Interface

public function getTimestampValidationResult($timestampindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 370 , $timestampindex);

Default Value

0

Remarks

Contains the timestamp validation outcome.

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

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

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

Data Type

Integer

TimestampServer Property (SecureBlackbox_CAdESSigner Class)

The address of the timestamping server.

Object Oriented Interface

public function getTimestampServer();


public function setTimestampServer($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 371 );


secureblackbox_cadessigner_set($res, 371, $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 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_CAdESSigner Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 372 );


secureblackbox_cadessigner_set($res, 372, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 373 , $tlsclientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);


public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 381 , $tlsclientcertindex);


secureblackbox_cadessigner_set($res, 381, $value , $tlsclientcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_cadessigner_get($res, 412 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertFingerprint
• TLSServerCertHandle
• TLSServerCertIssuer
• TLSServerCertIssuerRDN
• TLSServerCertKeyAlgorithm
• TLSServerCertKeyBits
• TLSServerCertKeyUsage
• TLSServerCertSelfSigned
• TLSServerCertSerialNumber
• TLSServerCertSigAlgorithm
• TLSServerCertSubject
• TLSServerCertSubjectRDN
• TLSServerCertValidFrom
• TLSServerCertValidTo

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 413 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSServerCertFingerprint Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 419 , $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 property.

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

Data Type

String

TLSServerCertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 421 , $tlsservercertindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

TLSServerCertIssuer Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 423 , $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.

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

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

Data Type

String

TLSServerCertIssuerRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 424 , $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 property.

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

Data Type

String

TLSServerCertKeyAlgorithm Property (SecureBlackbox_CAdESSigner Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 425 , $tlsservercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the TLSKeyBits, TLSCurve, and 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 property.

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

Data Type

String

TLSServerCertKeyBits Property (SecureBlackbox_CAdESSigner Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 426 , $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 or 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 property.

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

Data Type

Integer

TLSServerCertKeyUsage Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertKeyUsage($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 428 , $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:

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

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

Data Type

Integer

TLSServerCertSelfSigned Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertSelfSigned($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 441 , $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 property.

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

Data Type

Boolean

TLSServerCertSerialNumber Property (SecureBlackbox_CAdESSigner Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 442 , $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 property.

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

Data Type

Byte Array

TLSServerCertSigAlgorithm Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 443 , $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 property.

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

Data Type

String

TLSServerCertSubject Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertSubject($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 445 , $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.

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

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

Data Type

String

TLSServerCertSubjectRDN Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 448 , $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 property.

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

Data Type

String

TLSServerCertValidFrom Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 450 , $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 property.

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

Data Type

String

TLSServerCertValidTo Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 451 , $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 property.

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

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 452 );


secureblackbox_cadessigner_set($res, 452, $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_CAdESSigner Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 453 );


secureblackbox_cadessigner_set($res, 453, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_CAdESSigner Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 454 );


secureblackbox_cadessigner_set($res, 454, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSClientAuth Property (SecureBlackbox_CAdESSigner Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 455 );


secureblackbox_cadessigner_set($res, 455, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (SecureBlackbox_CAdESSigner Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 456 );


secureblackbox_cadessigner_set($res, 456, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_CAdESSigner Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 457 );


secureblackbox_cadessigner_set($res, 457, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 458 );


secureblackbox_cadessigner_set($res, 458, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 459 );


secureblackbox_cadessigner_set($res, 459, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 460 );


secureblackbox_cadessigner_set($res, 460, $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_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 461 );


secureblackbox_cadessigner_set($res, 461, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_CAdESSigner Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 462 );


secureblackbox_cadessigner_set($res, 462, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 463 );


secureblackbox_cadessigner_set($res, 463, $value );

Default Value

1

Remarks

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_CAdESSigner Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 464 );


secureblackbox_cadessigner_set($res, 464, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_CAdESSigner Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 465 );


secureblackbox_cadessigner_set($res, 465, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 466 );


secureblackbox_cadessigner_set($res, 466, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_CAdESSigner Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 467 );


secureblackbox_cadessigner_set($res, 467, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_CAdESSigner Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 468 );


secureblackbox_cadessigner_set($res, 468, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 469 );


secureblackbox_cadessigner_set($res, 469, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_CAdESSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_cadessigner_get($res, 470 , $trustedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 478 , $trustedcertindex);


secureblackbox_cadessigner_set($res, 478, $value , $trustedcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UnsignedAttributeCount Property (SecureBlackbox_CAdESSigner Class)

The number of records in the UnsignedAttribute arrays.

Object Oriented Interface

public function getUnsignedAttributeCount();


public function setUnsignedAttributeCount($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 509 );


secureblackbox_cadessigner_set($res, 509, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UnsignedAttributeOID
• UnsignedAttributeValue

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

This property is not available at design time.

Data Type

Integer

UnsignedAttributeOID Property (SecureBlackbox_CAdESSigner Class)

The object identifier of the attribute.

Object Oriented Interface

public function getUnsignedAttributeOID($unsignedattributeindex);


public function setUnsignedAttributeOID($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 510 , $unsignedattributeindex);


secureblackbox_cadessigner_set($res, 510, $value , $unsignedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

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

This property is not available at design time.

Data Type

String

UnsignedAttributeValue Property (SecureBlackbox_CAdESSigner Class)

The value of the attribute.

Object Oriented Interface

public function getUnsignedAttributeValue($unsignedattributeindex);


public function setUnsignedAttributeValue($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_cadessigner_get($res, 511 , $unsignedattributeindex);


secureblackbox_cadessigner_set($res, 511, $value , $unsignedattributeindex);

Remarks

The value of the attribute.

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

This property is not available at design time.

Data Type

Byte Array

ValidationMoment Property (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface

secureblackbox_cadessigner_get($res, 512 );


secureblackbox_cadessigner_set($res, 512, $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

AddAttribute Method (SecureBlackbox_CAdESSigner Class)

Adds an attribute to the signature.

Object Oriented Interface

public function doAddAttribute($oid, $value, $signedattribute);

Procedural Interface

secureblackbox_cadessigner_do_addattribute($res, $oid, $value, $signedattribute);

Remarks

Use this method to add a signed or unsigned attribute to the collection of attributes included in the new signature.

Note that CAdESSigner creates certain mandatory and/or widely used attributes automatically in accordance with requirements for a specific signing profile. For example, attributes such as SigningCertificateV2 or SigningTime are always added. Policy attributes are added if specified via the PolicyID or PolicyURI properties of the signature object.

Use the OID parameter to provide the object identifier of the attribute, in string form. For example, the OID for the SigningCertificateV2 attribute is 1.2.840.113549.1.9.16.2.47. The Value parameter should contain a well-formed, DER-encoded representation of the attribute value, in accordance with its specification.

Archive Method (SecureBlackbox_CAdESSigner Class)

Archives the signature.

Object Oriented Interface

public function doArchive($siglabel, $baseline);

Procedural Interface

secureblackbox_cadessigner_do_archive($res, $siglabel, $baseline);

Remarks

Call this method to produce an archival signature. Archival signature (CAdES-A) is built on top of CAdES-XL by certifying it with an archival timestamp.

Set Baseline to True to produce a baseline CAdES-A.

Close Method (SecureBlackbox_CAdESSigner Class)

Closes an opened container.

Object Oriented Interface

public function doClose($savechanges);

Procedural Interface

secureblackbox_cadessigner_do_close($res, $savechanges);

Remarks

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

Config Method (SecureBlackbox_CAdESSigner Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_cadessigner_do_config($res, $configurationstring);

Remarks

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

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

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

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

CreateNew Method (SecureBlackbox_CAdESSigner Class)

Create a new CAdES signature.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

secureblackbox_cadessigner_do_createnew($res);

Remarks

Use this method to create a new CAdES signature. When finished, call Close to complete or discard the operation.

DoAction Method (SecureBlackbox_CAdESSigner Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Remarks

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

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

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

ExtractAsyncData Method (SecureBlackbox_CAdESSigner Class)

Extracts user data from the DC signing service response.

Object Oriented Interface

public function doExtractAsyncData($asyncreply);

Procedural Interface

secureblackbox_cadessigner_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_CAdESSigner Class)

Opens an existing container for signing or updating.

Object Oriented Interface

public function doOpen();

Procedural Interface

secureblackbox_cadessigner_do_open($res);

Remarks

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

Reset Method (SecureBlackbox_CAdESSigner Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_cadessigner_do_reset($res);

Remarks

Reset is a generic method available in every class.

Revalidate Method (SecureBlackbox_CAdESSigner Class)

Revalidates a signature in accordance with current settings.

Object Oriented Interface

public function doRevalidate($siglabel);

Procedural Interface

secureblackbox_cadessigner_do_revalidate($res, $siglabel);

Remarks

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

SelectInfo Method (SecureBlackbox_CAdESSigner Class)

Select signature information for a specific entity.

Object Oriented Interface

public function doSelectInfo($entitylabel, $infotype, $clearselection);

Procedural Interface

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

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

Creates a new CAdES signature over the provided data.

Object Oriented Interface

public function doSign();

Procedural Interface

secureblackbox_cadessigner_do_sign($res);

Remarks

Call this method to produce a new signature over the provided data.

SignAsyncBegin Method (SecureBlackbox_CAdESSigner Class)

Initiates the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncBegin();

Procedural Interface

secureblackbox_cadessigner_do_signasyncbegin($res);

Remarks

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

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

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

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

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

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

SignAsyncEnd Method (SecureBlackbox_CAdESSigner Class)

Completes the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncEnd($asyncreply);

Procedural Interface

secureblackbox_cadessigner_do_signasyncend($res, $asyncreply);

Remarks

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

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

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

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

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

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

SignExternal Method (SecureBlackbox_CAdESSigner Class)

Signs the document using an external signing facility.

Object Oriented Interface

public function doSignExternal();

Procedural Interface

secureblackbox_cadessigner_do_signexternal($res);

Remarks

Use this method to create a CAdES signature using an external signing facility for the cryptographic computations. SignRemote delegates the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

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

Timestamp Method (SecureBlackbox_CAdESSigner Class)

Use this method to add timestamp.

Object Oriented Interface

public function doTimestamp($siglabel, $timestamptype);

Procedural Interface

secureblackbox_cadessigner_do_timestamp($res, $siglabel, $timestamptype);

Remarks

Call this method to add a timestamp to the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. Use the TimestampType parameter to specify the type of timestamp to create

Supported timestamp types:

Upgrade Method (SecureBlackbox_CAdESSigner Class)

Upgrades existing CAdES to a new level.

Object Oriented Interface

public function doUpgrade($siglabel, $upgradekind);

Procedural Interface

secureblackbox_cadessigner_do_upgrade($res, $siglabel, $upgradekind);

Remarks

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes. Use this method to upgrade CAdES to a new level specified by UpgradeKind. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, XL, A).

Supported levels:

The supported additional upgrade kinds are:

ChainElementDownload Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireChainElementDownload($param);

Procedural Interface

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

Parameter List

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

Remarks

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

ChainElementNeeded Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireChainElementNeeded($param);

Procedural Interface

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

Parameter List

 'kind'
 'certrdn'
 'cacertrdn'

Remarks

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

ChainValidated Event (SecureBlackbox_CAdESSigner Class)

Reports the completion of a certificate chain validation.

Object Oriented Interface

public function fireChainValidated($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 3, array($this, 'fireChainValidated'));

Parameter List

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

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

ChainValidationProgress Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireChainValidationProgress($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 4, array($this, 'fireChainValidationProgress'));

Parameter List

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

Remarks

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

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

Error Event (SecureBlackbox_CAdESSigner Class)

Information about errors during CAdES signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ExternalSign Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 6, array($this, 'fireExternalSign'));

Parameter List

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

Remarks

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

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

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

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

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

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

Loaded Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireLoaded($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 7, array($this, 'fireLoaded'));

Parameter List

 'cancel'

Remarks

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

Set Cancel to true to terminate CAdES signature processing on this stage.

Notification Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 8, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

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

SignatureFound Event (SecureBlackbox_CAdESSigner Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 9, array($this, 'fireSignatureFound'));

Parameter List

 '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_CAdESSigner Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 10, array($this, 'fireSignatureValidated'));

Parameter List

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

TimestampFound Event (SecureBlackbox_CAdESSigner Class)

Signifies the start of a timestamp validation routine.

Object Oriented Interface

public function fireTimestampFound($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 11, array($this, 'fireTimestampFound'));

Parameter List

 '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_CAdESSigner Class)

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

Object Oriented Interface

public function fireTimestampRequest($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 12, array($this, 'fireTimestampRequest'));

Parameter List

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

Remarks

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

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

TimestampValidated Event (SecureBlackbox_CAdESSigner Class)

Reports the completion of the timestamp validation routine.

Object Oriented Interface

public function fireTimestampValidated($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 13, array($this, 'fireTimestampValidated'));

Parameter List

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

TLSCertNeeded Event (SecureBlackbox_CAdESSigner Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 14, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

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

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

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

TLSCertValidate Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 15, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

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

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

TLSEstablished Event (SecureBlackbox_CAdESSigner Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 16, array($this, 'fireTLSEstablished'));

Parameter List

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

Remarks

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

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

TLSHandshake Event (SecureBlackbox_CAdESSigner Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 17, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

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

TLSShutdown Event (SecureBlackbox_CAdESSigner Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_cadessigner_register_callback($res, 18, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

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

Config Settings (CAdESSigner Class)

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

CAdESSigner Config Settings

Base Config Settings

Trappable Errors (CAdESSigner Class)

CAdESSigner Errors