XMLVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The XMLVerifier class verifies signed XML files.

Class Name

SecureBlackbox_XMLVerifier

Procedural Interface

 secureblackbox_xmlverifier_open();
 secureblackbox_xmlverifier_close($res);
 secureblackbox_xmlverifier_register_callback($res, $id, $function);
 secureblackbox_xmlverifier_get_last_error($res);
 secureblackbox_xmlverifier_get_last_error_code($res);
 secureblackbox_xmlverifier_set($res, $id, $index, $value);
 secureblackbox_xmlverifier_get($res, $id, $index);
 secureblackbox_xmlverifier_do_addknownnamespace($res, $prefix, $uri);
 secureblackbox_xmlverifier_do_close($res, $savechanges);
 secureblackbox_xmlverifier_do_config($res, $configurationstring);
 secureblackbox_xmlverifier_do_doaction($res, $actionid, $actionparams);
 secureblackbox_xmlverifier_do_getinnerxml($res, $xpath);
 secureblackbox_xmlverifier_do_getouterxml($res, $xpath);
 secureblackbox_xmlverifier_do_getsigneddata($res, $siglabel, $refindex);
 secureblackbox_xmlverifier_do_gettextcontent($res, $xpath);
 secureblackbox_xmlverifier_do_open($res);
 secureblackbox_xmlverifier_do_reset($res);
 secureblackbox_xmlverifier_do_revalidate($res, $siglabel, $detached);
 secureblackbox_xmlverifier_do_selectinfo($res, $entitylabel, $infotype, $clearselection);
 secureblackbox_xmlverifier_do_setinnerxml($res, $xpath, $value);
 secureblackbox_xmlverifier_do_settextcontent($res, $xpath, $value);
 secureblackbox_xmlverifier_do_unsign($res, $siglabel);
 secureblackbox_xmlverifier_do_verify($res);
 secureblackbox_xmlverifier_do_verifydetached($res);

Remarks

Use this control to validate XML-SIG signatures. Note that this component only validates the signatures, but not the signing chains. To validate the signing chains, use XAdESVerifier.

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.

AllSignaturesValid Property (SecureBlackbox_XMLVerifier Class)

The cumulative validity of all signatures.

Object Oriented Interface

public function getAllSignaturesValid();

Procedural Interface

secureblackbox_xmlverifier_get($res, 1 );

Default Value

false

Remarks

Use this property to check if all the signatures found in the message or document are valid.

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

Data Type

Boolean

AutoValidateSignatures Property (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function getAutoValidateSignatures();


public function setAutoValidateSignatures($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 2 );


secureblackbox_xmlverifier_set($res, 2, $value );

Default Value

true

Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.

Data Type

Boolean

CertCount Property (SecureBlackbox_XMLVerifier Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_xmlverifier_get($res, 3 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 4 , $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_XMLVerifier Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 5 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 6 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertCertType($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 7 , $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_XMLVerifier 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_xmlverifier_get($res, 8 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 9 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 10 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 11 , $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_XMLVerifier 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_xmlverifier_get($res, 12 , $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_XMLVerifier 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_xmlverifier_get($res, 13 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 14 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 15 , $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_XMLVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 16 , $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_XMLVerifier Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 17 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 18 , $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_XMLVerifier 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_xmlverifier_get($res, 19 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 20 , $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_XMLVerifier 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_xmlverifier_get($res, 21 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertOCSPNoCheck($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 22 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertOrigin($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 23 , $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_XMLVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 24 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertPrivateKeyBytes($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 25 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertPrivateKeyExists($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 26 , $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_XMLVerifier Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCertPrivateKeyExtractable($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 27 , $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_XMLVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 28 , $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_XMLVerifier Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCertQualified($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 29 , $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_XMLVerifier Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 30 , $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_XMLVerifier Class)

A list of qualifiers.

Object Oriented Interface

public function getCertQualifiers($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 31 , $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_XMLVerifier 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_xmlverifier_get($res, 32 , $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_XMLVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 33 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 34 , $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_XMLVerifier 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_xmlverifier_get($res, 35 , $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_XMLVerifier 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_xmlverifier_get($res, 36 , $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_XMLVerifier 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_xmlverifier_get($res, 37 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 38 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 39 , $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_XMLVerifier 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_xmlverifier_get($res, 40 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 41 , $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_XMLVerifier Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 42 , $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

DataBytes Property (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function getDataBytes();


public function setDataBytes($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 43 );


secureblackbox_xmlverifier_set($res, 43, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_XMLVerifier Class)

A file containing the external data covered by a detached signature.

Object Oriented Interface

public function getDataFile();


public function setDataFile($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 44 );


secureblackbox_xmlverifier_set($res, 44, $value );

Default Value

''

Remarks

In the case of a detached signature, use this property to provide the external data to the class from a file. Alternatively, provide the data via DataStream.

Data Type

String

DataType Property (SecureBlackbox_XMLVerifier Class)

Specifies the external data type.

Object Oriented Interface

public function getDataType();


public function setDataType($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 45 );


secureblackbox_xmlverifier_set($res, 45, $value );

Default Value

0

Remarks

Use this property to specify the type of the external data (either DataFile, DataStream or DataBytes properties) for class.

Data Type

Integer

DataURI Property (SecureBlackbox_XMLVerifier Class)

Specifies a detached data resource URI.

Object Oriented Interface

public function getDataURI();


public function setDataURI($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 46 );


secureblackbox_xmlverifier_set($res, 46, $value );

Default Value

''

Remarks

Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.

Data Type

String

Encoding Property (SecureBlackbox_XMLVerifier Class)

Specifies XML encoding.

Object Oriented Interface

public function getEncoding();


public function setEncoding($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 47 );


secureblackbox_xmlverifier_set($res, 47, $value );

Default Value

''

Remarks

Use this property to specify the encoding to apply to the XML documents.

Data Type

String

FIPSMode Property (SecureBlackbox_XMLVerifier Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 48 );


secureblackbox_xmlverifier_set($res, 48, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_XMLVerifier 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_xmlverifier_get($res, 49 );


secureblackbox_xmlverifier_set($res, 49, $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_XMLVerifier Class)

A signed XML file.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 50 );


secureblackbox_xmlverifier_set($res, 50, $value );

Default Value

''

Remarks

Provide a path to the signed XML document in this property.

Data Type

String

KnownCertCount Property (SecureBlackbox_XMLVerifier Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 51 );


secureblackbox_xmlverifier_set($res, 51, $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_XMLVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 52 , $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_XMLVerifier 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_xmlverifier_get($res, 60 , $knowncertindex);


secureblackbox_xmlverifier_set($res, 60, $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

OutputBytes Property (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_xmlverifier_get($res, 91 );

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

The file where the modified signed document will be saved.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_xmlverifier_get($res, 92 );


secureblackbox_xmlverifier_set($res, 92, $value );

Default Value

''

Remarks

Provide the full path to the file where the modified signed document should be saved.

Data Type

String

ReferenceCount Property (SecureBlackbox_XMLVerifier Class)

The number of records in the Reference arrays.

Object Oriented Interface

public function getReferenceCount();

Procedural Interface

secureblackbox_xmlverifier_get($res, 93 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceCanonicalizationMethod
• ReferenceCustomElementId
• ReferenceDigestValue
• ReferenceHandle
• ReferenceHashAlgorithm
• ReferenceHasURI
• ReferenceID
• ReferenceInclusiveNamespacesPrefixList
• ReferenceReferenceType
• ReferenceTargetData
• ReferenceTargetType
• ReferenceTargetXMLElement
• ReferenceURI
• ReferenceUseBase64Transform
• ReferenceUseEnvelopedSignatureTransform
• ReferenceUseXPathFilter2Transform
• ReferenceUseXPathTransform
• ReferenceValidationResult
• ReferenceXPathExpression
• ReferenceXPathFilter2Expressions
• ReferenceXPathFilter2Filters
• ReferenceXPathFilter2PrefixList
• ReferenceXPathPrefixList

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

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

Data Type

Integer

ReferenceCanonicalizationMethod Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify the canonicalization method for the transform of the reference.

Object Oriented Interface

public function getReferenceCanonicalizationMethod($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 95 , $referenceindex);

Default Value

0

Remarks

Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.

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

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

Data Type

Integer

ReferenceCustomElementId Property (SecureBlackbox_XMLVerifier Class)

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.

Object Oriented Interface

public function getReferenceCustomElementId($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 96 , $referenceindex);

Default Value

''

Remarks

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.

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

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

Data Type

String

ReferenceDigestValue Property (SecureBlackbox_XMLVerifier Class)

Use this property to get or set the value of the digest calculated over the referenced data.

Object Oriented Interface

public function getReferenceDigestValue($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 101 , $referenceindex);

Remarks

Use this property to get or set the value of the digest calculated over the referenced data.

This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.

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

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

Data Type

Byte Array

ReferenceHandle Property (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function getReferenceHandle($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 102 , $referenceindex);

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

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

Data Type

Long64

ReferenceHashAlgorithm Property (SecureBlackbox_XMLVerifier Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getReferenceHashAlgorithm($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 104 , $referenceindex);

Default Value

'SHA256'

Remarks

Specifies the hash algorithm to be used.

Supported values:

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

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

Data Type

String

ReferenceHasURI Property (SecureBlackbox_XMLVerifier Class)

Specifies whether the URI is set (even when it is empty).

Object Oriented Interface

public function getReferenceHasURI($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 105 , $referenceindex);

Default Value

true

Remarks

Specifies whether the URI is set (even when it is empty).

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

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

Data Type

Boolean

ReferenceID Property (SecureBlackbox_XMLVerifier Class)

A user-defined identifier (ID) attribute of this Reference element.

Object Oriented Interface

public function getReferenceID($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 106 , $referenceindex);

Default Value

''

Remarks

A user-defined identifier (ID) attribute of this Reference element.

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

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

Data Type

String

ReferenceInclusiveNamespacesPrefixList Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.

Object Oriented Interface

public function getReferenceInclusiveNamespacesPrefixList($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 107 , $referenceindex);

Default Value

''

Remarks

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.

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

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

Data Type

String

ReferenceReferenceType Property (SecureBlackbox_XMLVerifier Class)

The Reference's type attribute as defined in XMLDSIG specification.

Object Oriented Interface

public function getReferenceReferenceType($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 108 , $referenceindex);

Default Value

''

Remarks

The Reference's type attribute as defined in XMLDSIG specification.

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

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

Data Type

String

ReferenceTargetData Property (SecureBlackbox_XMLVerifier Class)

Contains the referenced external data when the digest value is not explicitly specified.

Object Oriented Interface

public function getReferenceTargetData($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 109 , $referenceindex);

Remarks

Contains the referenced external data when the digest value is not explicitly specified.

This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.

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

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

Data Type

Byte Array

ReferenceTargetType Property (SecureBlackbox_XMLVerifier Class)

The reference's target type to use.

Object Oriented Interface

public function getReferenceTargetType($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 110 , $referenceindex);

Default Value

0

Remarks

The reference's target type to use.

Use this property to specify the reference's target type to use when forming the signature.

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

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

Data Type

Integer

ReferenceTargetXMLElement Property (SecureBlackbox_XMLVerifier Class)

This property specifies the referenced XML element.

Object Oriented Interface

public function getReferenceTargetXMLElement($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 111 , $referenceindex);

Default Value

''

Remarks

This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.

Supported values are:

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

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

Data Type

String

ReferenceURI Property (SecureBlackbox_XMLVerifier Class)

Use this property to get or set the URL which references the data.

Object Oriented Interface

public function getReferenceURI($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 112 , $referenceindex);

Default Value

''

Remarks

Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.

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

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

Data Type

String

ReferenceUseBase64Transform Property (SecureBlackbox_XMLVerifier Class)

Specifies whether Base64 transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseBase64Transform($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 113 , $referenceindex);

Default Value

false

Remarks

Specifies whether Base64 transform is included in transform chain.

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

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

Data Type

Boolean

ReferenceUseEnvelopedSignatureTransform Property (SecureBlackbox_XMLVerifier Class)

Specifies whether enveloped signature transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseEnvelopedSignatureTransform($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 114 , $referenceindex);

Default Value

false

Remarks

Specifies whether enveloped signature transform is included in transform chain.

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

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

Data Type

Boolean

ReferenceUseXPathFilter2Transform Property (SecureBlackbox_XMLVerifier Class)

Specifies whether XPath Filter 2.

Object Oriented Interface

public function getReferenceUseXPathFilter2Transform($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 115 , $referenceindex);

Default Value

false

Remarks

Specifies whether XPath Filter 2.0 transform is included in transform chain.

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

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

Data Type

Boolean

ReferenceUseXPathTransform Property (SecureBlackbox_XMLVerifier Class)

Specifies whether XPath transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseXPathTransform($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 116 , $referenceindex);

Default Value

false

Remarks

Specifies whether XPath transform is included in transform chain.

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

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

Data Type

Boolean

ReferenceValidationResult Property (SecureBlackbox_XMLVerifier Class)

The outcome of the cryptographic reference validation.

Object Oriented Interface

public function getReferenceValidationResult($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 117 , $referenceindex);

Default Value

false

Remarks

The outcome of the cryptographic reference validation.

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

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

Data Type

Boolean

ReferenceXPathExpression Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify XPath expression for XPath transform of the reference.

Object Oriented Interface

public function getReferenceXPathExpression($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 118 , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPath expression for XPath transform of the reference.

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

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

Data Type

String

ReferenceXPathFilter2Expressions Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify XPointer expression(s) for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2Expressions($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 119 , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.

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

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

Data Type

String

ReferenceXPathFilter2Filters Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify XPointer filter(s) for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2Filters($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 120 , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.

Supported values:

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

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

Data Type

String

ReferenceXPathFilter2PrefixList Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify a prefix list for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2PrefixList($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 121 , $referenceindex);

Default Value

''

Remarks

Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

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

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

Data Type

String

ReferenceXPathPrefixList Property (SecureBlackbox_XMLVerifier Class)

Use this property to specify a prefix list for XPath transform of the reference.

Object Oriented Interface

public function getReferenceXPathPrefixList($referenceindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 122 , $referenceindex);

Default Value

''

Remarks

Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

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

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

Data Type

String

SignatureCount Property (SecureBlackbox_XMLVerifier Class)

The number of records in the Signature arrays.

Object Oriented Interface

public function getSignatureCount();

Procedural Interface

secureblackbox_xmlverifier_get($res, 123 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCanonicalizationMethod
• SignatureCompatibilityErrors
• SignatureEntityLabel
• SignatureHandle
• SignatureHashAlgorithm
• SignatureIssuerRDN
• SignatureParentEntity
• SignatureSerialNumber
• SignatureSignatureBytes
• SignatureSignatureType
• SignatureSignatureValidationResult
• SignatureSubjectKeyID
• SignatureSubjectRDN
• SignatureXMLElement

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

SignatureCanonicalizationMethod Property (SecureBlackbox_XMLVerifier Class)

The XML canonicalization method that was used for signing.

Object Oriented Interface

public function getSignatureCanonicalizationMethod($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 124 , $signatureindex);

Default Value

0

Remarks

The XML canonicalization method that was used for signing.

Supported canonicalization methods:

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

SignatureCompatibilityErrors Property (SecureBlackbox_XMLVerifier Class)

Returns compatibility errors encountered during validation.

Object Oriented Interface

public function getSignatureCompatibilityErrors($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 125 , $signatureindex);

Default Value

0

Remarks

Returns compatibility errors encountered during validation.

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

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

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

Data Type

Integer

SignatureEntityLabel Property (SecureBlackbox_XMLVerifier Class)

Use this property to get the signature entity label.

Object Oriented Interface

public function getSignatureEntityLabel($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 126 , $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_XMLVerifier 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_xmlverifier_get($res, 127 , $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_XMLVerifier Class)

The hash algorithm used for signing.

Object Oriented Interface

public function getSignatureHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 128 , $signatureindex);

Default Value

'Unknown'

Remarks

The hash algorithm used for signing.

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

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

Data Type

String

SignatureIssuerRDN Property (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function getSignatureIssuerRDN($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 129 , $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

SignatureParentEntity Property (SecureBlackbox_XMLVerifier Class)

Use this property to get the parent signature label.

Object Oriented Interface

public function getSignatureParentEntity($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 130 , $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

SignatureSerialNumber Property (SecureBlackbox_XMLVerifier Class)

The serial number of the signing certificate.

Object Oriented Interface

public function getSignatureSerialNumber($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 131 , $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_XMLVerifier Class)

Returns the binary representation of the XML signature.

Object Oriented Interface

public function getSignatureSignatureBytes($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 132 , $signatureindex);

Remarks

Returns the binary representation of the XML 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

SignatureSignatureType Property (SecureBlackbox_XMLVerifier Class)

The signature type to employ when signing the document.

Object Oriented Interface

public function getSignatureSignatureType($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 133 , $signatureindex);

Default Value

4

Remarks

The signature type to employ when signing the document.

This property specifies the signature type to be used when signing the document.

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

SignatureSignatureValidationResult Property (SecureBlackbox_XMLVerifier Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSignatureSignatureValidationResult($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 134 , $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_XMLVerifier Class)

Contains the subject key identifier of the signing certificate.

Object Oriented Interface

public function getSignatureSubjectKeyID($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 135 , $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_XMLVerifier Class)

Contains information about the person owning the signing certificate.

Object Oriented Interface

public function getSignatureSubjectRDN($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 136 , $signatureindex);

Default Value

''

Remarks

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

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

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

Data Type

String

SignatureXMLElement Property (SecureBlackbox_XMLVerifier Class)

Specifies the XML element where to save the signature or containing the signature.

Object Oriented Interface

public function getSignatureXMLElement($signatureindex);

Procedural Interface

secureblackbox_xmlverifier_get($res, 137 , $signatureindex);

Default Value

''

Remarks

Specifies the XML element where to save the signature or containing the signature.

This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.

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

String

AddKnownNamespace Method (SecureBlackbox_XMLVerifier Class)

Adds known prefix and correspondent namespace URI.

Object Oriented Interface

public function doAddKnownNamespace($prefix, $uri);

Procedural Interface

secureblackbox_xmlverifier_do_addknownnamespace($res, $prefix, $uri);

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

Close Method (SecureBlackbox_XMLVerifier Class)

Closes an opened document.

Object Oriented Interface

public function doClose($savechanges);

Procedural Interface

secureblackbox_xmlverifier_do_close($res, $savechanges);

Remarks

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

Config Method (SecureBlackbox_XMLVerifier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_xmlverifier_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoAction Method (SecureBlackbox_XMLVerifier Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_xmlverifier_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;....

GetInnerXML Method (SecureBlackbox_XMLVerifier Class)

Get the inner XML content of the selected XML element.

Object Oriented Interface

public function doGetInnerXML($xpath);

Procedural Interface

secureblackbox_xmlverifier_do_getinnerxml($res, $xpath);

Remarks

Call this method to get the inner XML content of the selected XML element.

GetOuterXML Method (SecureBlackbox_XMLVerifier Class)

Get the outer XML content of the selected XML element.

Object Oriented Interface

public function doGetOuterXML($xpath);

Procedural Interface

secureblackbox_xmlverifier_do_getouterxml($res, $xpath);

Remarks

Call this method to get the outer XML content of the selected XML element.

GetSignedData Method (SecureBlackbox_XMLVerifier Class)

Returns the part of the XML document that is covered by the signature.

Object Oriented Interface

public function doGetSignedData($siglabel, $refindex);

Procedural Interface

secureblackbox_xmlverifier_do_getsigneddata($res, $siglabel, $refindex);

Remarks

Use this method to retrieve the part of the XML document or data that is covered by the SigLabel signature and referenced by RefIndex reference.

GetTextContent Method (SecureBlackbox_XMLVerifier Class)

Get the text content of the selected XML element.

Object Oriented Interface

public function doGetTextContent($xpath);

Procedural Interface

secureblackbox_xmlverifier_do_gettextcontent($res, $xpath);

Remarks

Call this method to get the text content of the selected XML element.

Open Method (SecureBlackbox_XMLVerifier Class)

Opens a document for verifying or removing signatures.

Object Oriented Interface

public function doOpen();

Procedural Interface

secureblackbox_xmlverifier_do_open($res);

Remarks

Use this method to open a document for verifying or removing signatures. When finished, call Close to complete or discard the operation.

Reset Method (SecureBlackbox_XMLVerifier Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_xmlverifier_do_reset($res);

Remarks

Reset is a generic method available in every class.

Revalidate Method (SecureBlackbox_XMLVerifier Class)

Revalidates a signature in accordance with current settings.

Object Oriented Interface

public function doRevalidate($siglabel, $detached);

Procedural Interface

secureblackbox_xmlverifier_do_revalidate($res, $siglabel, $detached);

Remarks

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

SelectInfo Method (SecureBlackbox_XMLVerifier Class)

Select signature information for a specific entity.

Object Oriented Interface

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

Procedural Interface

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

SetInnerXML Method (SecureBlackbox_XMLVerifier Class)

Set the inner XML content of the selected XML element.

Object Oriented Interface

public function doSetInnerXML($xpath, $value);

Procedural Interface

secureblackbox_xmlverifier_do_setinnerxml($res, $xpath, $value);

Remarks

Call this method to set the inner XML content of the selected XML element.

SetTextContent Method (SecureBlackbox_XMLVerifier Class)

Set the text content of the selected XML element.

Object Oriented Interface

public function doSetTextContent($xpath, $value);

Procedural Interface

secureblackbox_xmlverifier_do_settextcontent($res, $xpath, $value);

Remarks

Call this method to set the text content of the selected XML element.

Unsign Method (SecureBlackbox_XMLVerifier Class)

Deletes a signature from the document.

Object Oriented Interface

public function doUnsign($siglabel);

Procedural Interface

secureblackbox_xmlverifier_do_unsign($res, $siglabel);

Remarks

Use this method to delete an existing signature from the document. Use SigLabel parameter to specify the signature to be removed.

Verify Method (SecureBlackbox_XMLVerifier Class)

Verifies a signed XML document.

Object Oriented Interface

public function doVerify();

Procedural Interface

secureblackbox_xmlverifier_do_verify($res);

Remarks

Call this method to verify the signature embedded in the document. Pass the document via InputStream or InputFile property. Use VerifyDetached to verify the external data in case of a detached signature.

VerifyDetached Method (SecureBlackbox_XMLVerifier Class)

Verifies a detached signature over external XML data.

Object Oriented Interface

public function doVerifyDetached();

Procedural Interface

secureblackbox_xmlverifier_do_verifydetached($res);

Remarks

Call this method to verify a signature over external (detached) data provided via DataStream or DataFile.

DocumentLoaded Event (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function fireDocumentLoaded($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 1, array($this, 'fireDocumentLoaded'));

Parameter List

 'cancel'

Remarks

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

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

Error Event (SecureBlackbox_XMLVerifier Class)

Information about errors during signature verification.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during verification.

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

Notification Event (SecureBlackbox_XMLVerifier Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 3, 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:

ReferenceValidated Event (SecureBlackbox_XMLVerifier Class)

Marks the end of a reference validation.

Object Oriented Interface

public function fireReferenceValidated($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 4, array($this, 'fireReferenceValidated'));

Parameter List

 'referenceindex'
 'id'
 'uri'
 'reftype'
 'digestvalid'

Remarks

The class fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.

ResolveReference Event (SecureBlackbox_XMLVerifier Class)

Asks the application to resolve a reference.

Object Oriented Interface

public function fireResolveReference($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 5, array($this, 'fireResolveReference'));

Parameter List

 'referenceindex'
 'uri'

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

SignatureFound Event (SecureBlackbox_XMLVerifier Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_xmlverifier_register_callback($res, 6, 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_XMLVerifier Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

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

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

XMLVerifier Config Settings

Base Config Settings

Trappable Errors (XMLVerifier Class)

XMLVerifier Errors