XMLVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The XMLVerifier class verifies signed XML files.

Syntax

XMLVerifier

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 (XMLVerifier Class)

The cumulative validity of all signatures.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAllSignaturesValid();

Unicode (Windows)
BOOL GetAllSignaturesValid();

int secureblackbox_xmlverifier_getallsignaturesvalid(void* lpObj);

bool GetAllSignaturesValid();

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAutoValidateSignatures();
int SetAutoValidateSignatures(int bAutoValidateSignatures);

Unicode (Windows)
BOOL GetAutoValidateSignatures();
INT SetAutoValidateSignatures(BOOL bAutoValidateSignatures);

int secureblackbox_xmlverifier_getautovalidatesignatures(void* lpObj);
int secureblackbox_xmlverifier_setautovalidatesignatures(void* lpObj, int bAutoValidateSignatures);

bool GetAutoValidateSignatures();
int SetAutoValidateSignatures(bool bAutoValidateSignatures);

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 (XMLVerifier Class)

The number of records in the Cert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCount();

Unicode (Windows)
INT GetCertCount();

int secureblackbox_xmlverifier_getcertcount(void* lpObj);

int GetCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

CertBytes Property (XMLVerifier Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertBytes(int iCertIndex, char* &lpCertBytes, int &lenCertBytes);

Unicode (Windows)
INT GetCertBytes(INT iCertIndex, LPSTR &lpCertBytes, INT &lenCertBytes);

int secureblackbox_xmlverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);

QByteArray GetCertBytes(int iCertIndex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

CertCA Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCA(int iCertIndex);

Unicode (Windows)
BOOL GetCertCA(INT iCertIndex);

int secureblackbox_xmlverifier_getcertca(void* lpObj, int certindex);

bool GetCertCA(int iCertIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

CertCAKeyID Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCAKeyID(int iCertIndex, char* &lpCertCAKeyID, int &lenCertCAKeyID);

Unicode (Windows)
INT GetCertCAKeyID(INT iCertIndex, LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);

int secureblackbox_xmlverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);

QByteArray GetCertCAKeyID(int iCertIndex);

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

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

Data Type

Byte Array

CertCRLDistributionPoints Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCRLDistributionPoints(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCRLDistributionPoints(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertcrldistributionpoints(void* lpObj, int certindex);

QString GetCertCRLDistributionPoints(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertCurve Property (XMLVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCurve(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCurve(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertcurve(void* lpObj, int certindex);

QString GetCertCurve(int iCertIndex);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

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

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

Data Type

String

CertFingerprint Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertFingerprint(int iCertIndex, char* &lpCertFingerprint, int &lenCertFingerprint);

Unicode (Windows)
INT GetCertFingerprint(INT iCertIndex, LPSTR &lpCertFingerprint, INT &lenCertFingerprint);

int secureblackbox_xmlverifier_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);

QByteArray GetCertFingerprint(int iCertIndex);

Remarks

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

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

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

Data Type

Byte Array

CertFriendlyName Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertFriendlyName(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertFriendlyName(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertfriendlyname(void* lpObj, int certindex);

QString GetCertFriendlyName(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertHandle Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertHandle(int iCertIndex);

Unicode (Windows)
LONG64 GetCertHandle(INT iCertIndex);

int64 secureblackbox_xmlverifier_getcerthandle(void* lpObj, int certindex);

qint64 GetCertHandle(int iCertIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertHashAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertHashAlgorithm(INT iCertIndex);

char* secureblackbox_xmlverifier_getcerthashalgorithm(void* lpObj, int certindex);

QString GetCertHashAlgorithm(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertIssuer Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertIssuer(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuer(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertissuer(void* lpObj, int certindex);

QString GetCertIssuer(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertIssuerRDN Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertIssuerRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuerRDN(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertissuerrdn(void* lpObj, int certindex);

QString GetCertIssuerRDN(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertKeyAlgorithm Property (XMLVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertKeyAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertKeyAlgorithm(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertkeyalgorithm(void* lpObj, int certindex);

QString GetCertKeyAlgorithm(int iCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

CertKeyBits Property (XMLVerifier Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyBits(int iCertIndex);

Unicode (Windows)
INT GetCertKeyBits(INT iCertIndex);

int secureblackbox_xmlverifier_getcertkeybits(void* lpObj, int certindex);

int GetCertKeyBits(int iCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

CertKeyFingerprint Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyFingerprint(int iCertIndex, char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint);

Unicode (Windows)
INT GetCertKeyFingerprint(INT iCertIndex, LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);

int secureblackbox_xmlverifier_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);

QByteArray GetCertKeyFingerprint(int iCertIndex);

Remarks

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

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

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

Data Type

Byte Array

CertKeyUsage Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyUsage(int iCertIndex);

Unicode (Windows)
INT GetCertKeyUsage(INT iCertIndex);

int secureblackbox_xmlverifier_getcertkeyusage(void* lpObj, int certindex);

int GetCertKeyUsage(int iCertIndex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

CertKeyValid Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyValid(int iCertIndex);

Unicode (Windows)
BOOL GetCertKeyValid(INT iCertIndex);

int secureblackbox_xmlverifier_getcertkeyvalid(void* lpObj, int certindex);

bool GetCertKeyValid(int iCertIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertOCSPLocations(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertOCSPLocations(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertocsplocations(void* lpObj, int certindex);

QString GetCertOCSPLocations(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertPolicyIDs Property (XMLVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertPolicyIDs(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertPolicyIDs(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertpolicyids(void* lpObj, int certindex);

QString GetCertPolicyIDs(int iCertIndex);

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

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

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

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

Data Type

String

CertPublicKeyBytes Property (XMLVerifier Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPublicKeyBytes(int iCertIndex, char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes);

Unicode (Windows)
INT GetCertPublicKeyBytes(INT iCertIndex, LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);

int secureblackbox_xmlverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);

QByteArray GetCertPublicKeyBytes(int iCertIndex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

CertSelfSigned Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSelfSigned(int iCertIndex);

Unicode (Windows)
BOOL GetCertSelfSigned(INT iCertIndex);

int secureblackbox_xmlverifier_getcertselfsigned(void* lpObj, int certindex);

bool GetCertSelfSigned(int iCertIndex);

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 (XMLVerifier Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSerialNumber(int iCertIndex, char* &lpCertSerialNumber, int &lenCertSerialNumber);

Unicode (Windows)
INT GetCertSerialNumber(INT iCertIndex, LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);

int secureblackbox_xmlverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);

QByteArray GetCertSerialNumber(int iCertIndex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

CertSigAlgorithm Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSigAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSigAlgorithm(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertsigalgorithm(void* lpObj, int certindex);

QString GetCertSigAlgorithm(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertSubject Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubject(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertsubject(void* lpObj, int certindex);

QString GetCertSubject(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertSubjectKeyID Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSubjectKeyID(int iCertIndex, char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID);

Unicode (Windows)
INT GetCertSubjectKeyID(INT iCertIndex, LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);

int secureblackbox_xmlverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);

QByteArray GetCertSubjectKeyID(int iCertIndex);

Remarks

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

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

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

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

Data Type

Byte Array

CertSubjectRDN Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubjectRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubjectRDN(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertsubjectrdn(void* lpObj, int certindex);

QString GetCertSubjectRDN(int iCertIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CertValidFrom Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidFrom(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidFrom(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertvalidfrom(void* lpObj, int certindex);

QString GetCertValidFrom(int iCertIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidTo(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidTo(INT iCertIndex);

char* secureblackbox_xmlverifier_getcertvalidto(void* lpObj, int certindex);

QString GetCertValidTo(int iCertIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDataBytes(char* &lpDataBytes, int &lenDataBytes);
int SetDataBytes(const char* lpDataBytes, int lenDataBytes);

Unicode (Windows)
INT GetDataBytes(LPSTR &lpDataBytes, INT &lenDataBytes);
INT SetDataBytes(LPCSTR lpDataBytes, INT lenDataBytes);

int secureblackbox_xmlverifier_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_xmlverifier_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);

QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataFile();
int SetDataFile(const char* lpszDataFile);

Unicode (Windows)
LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);

char* secureblackbox_xmlverifier_getdatafile(void* lpObj);
int secureblackbox_xmlverifier_setdatafile(void* lpObj, const char* lpszDataFile);

QString GetDataFile();
int SetDataFile(QString qsDataFile);

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 (XMLVerifier Class)

Specifies the external data type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDataType();
int SetDataType(int iDataType);

Unicode (Windows)
INT GetDataType();
INT SetDataType(INT iDataType);

CXDT_XML(0), 
CXDT_BINARY(1), 
CXDT_BASE_64(2)

int secureblackbox_xmlverifier_getdatatype(void* lpObj);
int secureblackbox_xmlverifier_setdatatype(void* lpObj, int iDataType);

int GetDataType();
int SetDataType(int iDataType);

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 (XMLVerifier Class)

Specifies a detached data resource URI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataURI();
int SetDataURI(const char* lpszDataURI);

Unicode (Windows)
LPWSTR GetDataURI();
INT SetDataURI(LPCWSTR lpszDataURI);

char* secureblackbox_xmlverifier_getdatauri(void* lpObj);
int secureblackbox_xmlverifier_setdatauri(void* lpObj, const char* lpszDataURI);

QString GetDataURI();
int SetDataURI(QString qsDataURI);

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 (XMLVerifier Class)

Specifies XML encoding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncoding();
int SetEncoding(const char* lpszEncoding);

Unicode (Windows)
LPWSTR GetEncoding();
INT SetEncoding(LPCWSTR lpszEncoding);

char* secureblackbox_xmlverifier_getencoding(void* lpObj);
int secureblackbox_xmlverifier_setencoding(void* lpObj, const char* lpszEncoding);

QString GetEncoding();
int SetEncoding(QString qsEncoding);

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (XMLVerifier Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_xmlverifier_getfipsmode(void* lpObj);
int secureblackbox_xmlverifier_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_xmlverifier_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_xmlverifier_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

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 (XMLVerifier Class)

A signed XML file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_xmlverifier_getinputfile(void* lpObj);
int secureblackbox_xmlverifier_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

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

Data Type

String

KnownCertCount Property (XMLVerifier Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_xmlverifier_getknowncertcount(void* lpObj);
int secureblackbox_xmlverifier_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

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 (XMLVerifier Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_xmlverifier_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_xmlverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_xmlverifier_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_xmlverifier_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if 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 (XMLVerifier Class)

The file where the modified signed document will be saved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_xmlverifier_getoutputfile(void* lpObj);
int secureblackbox_xmlverifier_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

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

Data Type

String

ReferenceCount Property (XMLVerifier Class)

The number of records in the Reference arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceCount();

Unicode (Windows)
INT GetReferenceCount();

int secureblackbox_xmlverifier_getreferencecount(void* lpObj);

int GetReferenceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceAutoGenerateElementId
• ReferenceCanonicalizationMethod
• ReferenceCustomElementId
• ReferenceDigestValue
• ReferenceHandle
• ReferenceHashAlgorithm
• ReferenceHasURI
• ReferenceID
• ReferenceInclusiveNamespacesPrefixList
• ReferenceReferenceType
• ReferenceSignatureIndex
• ReferenceTargetData
• ReferenceTargetType
• ReferenceTargetXMLElement
• ReferenceURI
• ReferenceUseBase64Transform
• ReferenceUseEnvelopedSignatureTransform
• ReferenceUseXPathFilter2Transform
• ReferenceUseXPathTransform
• 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

ReferenceAutoGenerateElementId Property (XMLVerifier Class)

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceAutoGenerateElementId(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceAutoGenerateElementId(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferenceautogenerateelementid(void* lpObj, int referenceindex);

bool GetReferenceAutoGenerateElementId(int iReferenceIndex);

Default Value

FALSE

Remarks

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are 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

ReferenceCanonicalizationMethod Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceCanonicalizationMethod(int iReferenceIndex);

Unicode (Windows)
INT GetReferenceCanonicalizationMethod(INT iReferenceIndex);

CXCM_NONE(0), 
CXCM_CANON(1), 
CXCM_CANON_COMMENT(2), 
CXCM_EXCL_CANON(3), 
CXCM_EXCL_CANON_COMMENT(4), 
CXCM_MIN_CANON(5), 
CXCM_CANON_V_1_1(6), 
CXCM_CANON_COMMENT_V_1_1(7)

int secureblackbox_xmlverifier_getreferencecanonicalizationmethod(void* lpObj, int referenceindex);

int GetReferenceCanonicalizationMethod(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceCustomElementId(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceCustomElementId(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencecustomelementid(void* lpObj, int referenceindex);

QString GetReferenceCustomElementId(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceDigestValue(int iReferenceIndex, char* &lpReferenceDigestValue, int &lenReferenceDigestValue);

Unicode (Windows)
INT GetReferenceDigestValue(INT iReferenceIndex, LPSTR &lpReferenceDigestValue, INT &lenReferenceDigestValue);

int secureblackbox_xmlverifier_getreferencedigestvalue(void* lpObj, int referenceindex, char** lpReferenceDigestValue, int* lenReferenceDigestValue);

QByteArray GetReferenceDigestValue(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReferenceHandle(int iReferenceIndex);

Unicode (Windows)
LONG64 GetReferenceHandle(INT iReferenceIndex);

int64 secureblackbox_xmlverifier_getreferencehandle(void* lpObj, int referenceindex);

qint64 GetReferenceHandle(int iReferenceIndex);

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 (XMLVerifier Class)

Specifies the hash algorithm to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceHashAlgorithm(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceHashAlgorithm(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencehashalgorithm(void* lpObj, int referenceindex);

QString GetReferenceHashAlgorithm(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceHasURI(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceHasURI(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferencehasuri(void* lpObj, int referenceindex);

bool GetReferenceHasURI(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceID(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceID(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferenceid(void* lpObj, int referenceindex);

QString GetReferenceID(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceInclusiveNamespacesPrefixList(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex);

QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceReferenceType(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceReferenceType(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencereferencetype(void* lpObj, int referenceindex);

QString GetReferenceReferenceType(int iReferenceIndex);

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

ReferenceSignatureIndex Property (XMLVerifier Class)

Returns the index of the owner signature, if applicable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceSignatureIndex(int iReferenceIndex);

Unicode (Windows)
INT GetReferenceSignatureIndex(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferencesignatureindex(void* lpObj, int referenceindex);

int GetReferenceSignatureIndex(int iReferenceIndex);

Default Value

-1

Remarks

Returns the index of the owner signature, if applicable.

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

The 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

ReferenceTargetData Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceTargetData(int iReferenceIndex, char* &lpReferenceTargetData, int &lenReferenceTargetData);

Unicode (Windows)
INT GetReferenceTargetData(INT iReferenceIndex, LPSTR &lpReferenceTargetData, INT &lenReferenceTargetData);

int secureblackbox_xmlverifier_getreferencetargetdata(void* lpObj, int referenceindex, char** lpReferenceTargetData, int* lenReferenceTargetData);

QByteArray GetReferenceTargetData(int iReferenceIndex);

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 (XMLVerifier Class)

The reference's target type to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceTargetType(int iReferenceIndex);

Unicode (Windows)
INT GetReferenceTargetType(INT iReferenceIndex);

RTT_AUTO(0), 
RTT_XMLELEMENT(1), 
RTT_DATA(2), 
RTT_URI(3)

int secureblackbox_xmlverifier_getreferencetargettype(void* lpObj, int referenceindex);

int GetReferenceTargetType(int iReferenceIndex);

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 (XMLVerifier Class)

This property specifies the referenced XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceTargetXMLElement(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceTargetXMLElement(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencetargetxmlelement(void* lpObj, int referenceindex);

QString GetReferenceTargetXMLElement(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceURI(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceURI(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferenceuri(void* lpObj, int referenceindex);

QString GetReferenceURI(int iReferenceIndex);

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 (XMLVerifier Class)

Specifies whether Base64 transform is included in transform chain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceUseBase64Transform(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceUseBase64Transform(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferenceusebase64transform(void* lpObj, int referenceindex);

bool GetReferenceUseBase64Transform(int iReferenceIndex);

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 (XMLVerifier Class)

Specifies whether enveloped signature transform is included in transform chain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceUseEnvelopedSignatureTransform(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex);

bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);

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 (XMLVerifier Class)

Specifies whether XPath Filter 2.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceUseXPathFilter2Transform(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceUseXPathFilter2Transform(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferenceusexpathfilter2transform(void* lpObj, int referenceindex);

bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);

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 (XMLVerifier Class)

Specifies whether XPath transform is included in transform chain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReferenceUseXPathTransform(int iReferenceIndex);

Unicode (Windows)
BOOL GetReferenceUseXPathTransform(INT iReferenceIndex);

int secureblackbox_xmlverifier_getreferenceusexpathtransform(void* lpObj, int referenceindex);

bool GetReferenceUseXPathTransform(int iReferenceIndex);

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

ReferenceXPathExpression Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceXPathExpression(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceXPathExpression(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencexpathexpression(void* lpObj, int referenceindex);

QString GetReferenceXPathExpression(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceXPathFilter2Expressions(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceXPathFilter2Expressions(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencexpathfilter2expressions(void* lpObj, int referenceindex);

QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceXPathFilter2Filters(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceXPathFilter2Filters(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencexpathfilter2filters(void* lpObj, int referenceindex);

QString GetReferenceXPathFilter2Filters(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceXPathFilter2PrefixList(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceXPathFilter2PrefixList(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencexpathfilter2prefixlist(void* lpObj, int referenceindex);

QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferenceXPathPrefixList(int iReferenceIndex);

Unicode (Windows)
LPWSTR GetReferenceXPathPrefixList(INT iReferenceIndex);

char* secureblackbox_xmlverifier_getreferencexpathprefixlist(void* lpObj, int referenceindex);

QString GetReferenceXPathPrefixList(int iReferenceIndex);

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 (XMLVerifier Class)

The number of records in the Signature arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureCount();

Unicode (Windows)
INT GetSignatureCount();

int secureblackbox_xmlverifier_getsignaturecount(void* lpObj);

int GetSignatureCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCanonicalizationMethod
• SignatureCertificateIndex
• SignatureHandle
• SignatureHashAlgorithm
• SignatureIssuerRDN
• 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 (XMLVerifier Class)

The XML canonicalization method that was used for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureCanonicalizationMethod(int iSignatureIndex);

Unicode (Windows)
INT GetSignatureCanonicalizationMethod(INT iSignatureIndex);

CXCM_NONE(0), 
CXCM_CANON(1), 
CXCM_CANON_COMMENT(2), 
CXCM_EXCL_CANON(3), 
CXCM_EXCL_CANON_COMMENT(4), 
CXCM_MIN_CANON(5), 
CXCM_CANON_V_1_1(6), 
CXCM_CANON_COMMENT_V_1_1(7)

int secureblackbox_xmlverifier_getsignaturecanonicalizationmethod(void* lpObj, int signatureindex);

int GetSignatureCanonicalizationMethod(int iSignatureIndex);

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

SignatureCertificateIndex Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureCertificateIndex(int iSignatureIndex);

Unicode (Windows)
INT GetSignatureCertificateIndex(INT iSignatureIndex);

int secureblackbox_xmlverifier_getsignaturecertificateindex(void* lpObj, int signatureindex);

int GetSignatureCertificateIndex(int iSignatureIndex);

Default Value

-1

Remarks

Returns the index of the signing certificate in the Certificates collection

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

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

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

Data Type

Integer

SignatureHandle Property (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSignatureHandle(int iSignatureIndex);

Unicode (Windows)
LONG64 GetSignatureHandle(INT iSignatureIndex);

int64 secureblackbox_xmlverifier_getsignaturehandle(void* lpObj, int signatureindex);

qint64 GetSignatureHandle(int iSignatureIndex);

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 (XMLVerifier Class)

The hash algorithm used for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureHashAlgorithm(int iSignatureIndex);

Unicode (Windows)
LPWSTR GetSignatureHashAlgorithm(INT iSignatureIndex);

char* secureblackbox_xmlverifier_getsignaturehashalgorithm(void* lpObj, int signatureindex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureIssuerRDN(int iSignatureIndex);

Unicode (Windows)
LPWSTR GetSignatureIssuerRDN(INT iSignatureIndex);

char* secureblackbox_xmlverifier_getsignatureissuerrdn(void* lpObj, int signatureindex);

QString GetSignatureIssuerRDN(int iSignatureIndex);

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

SignatureSerialNumber Property (XMLVerifier Class)

The serial number of the timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureSerialNumber(int iSignatureIndex, char* &lpSignatureSerialNumber, int &lenSignatureSerialNumber);

Unicode (Windows)
INT GetSignatureSerialNumber(INT iSignatureIndex, LPSTR &lpSignatureSerialNumber, INT &lenSignatureSerialNumber);

int secureblackbox_xmlverifier_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);

QByteArray GetSignatureSerialNumber(int iSignatureIndex);

Remarks

The serial number of the timestamp.

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

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

Data Type

Byte Array

SignatureSignatureBytes Property (XMLVerifier Class)

Returns the binary representation of the XML signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureSignatureBytes(int iSignatureIndex, char* &lpSignatureSignatureBytes, int &lenSignatureSignatureBytes);

Unicode (Windows)
INT GetSignatureSignatureBytes(INT iSignatureIndex, LPSTR &lpSignatureSignatureBytes, INT &lenSignatureSignatureBytes);

int secureblackbox_xmlverifier_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);

QByteArray GetSignatureSignatureBytes(int iSignatureIndex);

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 (XMLVerifier Class)

The signature type to employ when signing the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureSignatureType(int iSignatureIndex);

Unicode (Windows)
INT GetSignatureSignatureType(INT iSignatureIndex);

CXST_DETACHED(1), 
CXST_ENVELOPING(2), 
CXST_ENVELOPED(4)

int secureblackbox_xmlverifier_getsignaturesignaturetype(void* lpObj, int signatureindex);

int GetSignatureSignatureType(int iSignatureIndex);

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 (XMLVerifier Class)

Contains the signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureSignatureValidationResult(int iSignatureIndex);

Unicode (Windows)
INT GetSignatureSignatureValidationResult(INT iSignatureIndex);

XSV_VALID(0), 
XSV_UNKNOWN(1), 
XSV_CORRUPTED(2), 
XSV_SIGNER_NOT_FOUND(3), 
XSV_FAILURE(4), 
XSV_REFERENCE_CORRUPTED(5)

int secureblackbox_xmlverifier_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);

int GetSignatureSignatureValidationResult(int iSignatureIndex);

Default Value

0

Remarks

Contains the signature validation result.

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

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 (XMLVerifier Class)

Contains the subject key identifier of the signing certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureSubjectKeyID(int iSignatureIndex, char* &lpSignatureSubjectKeyID, int &lenSignatureSubjectKeyID);

Unicode (Windows)
INT GetSignatureSubjectKeyID(INT iSignatureIndex, LPSTR &lpSignatureSubjectKeyID, INT &lenSignatureSubjectKeyID);

int secureblackbox_xmlverifier_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);

QByteArray GetSignatureSubjectKeyID(int iSignatureIndex);

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 (XMLVerifier Class)

Contains information about the person owning the signing certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureSubjectRDN(int iSignatureIndex);

Unicode (Windows)
LPWSTR GetSignatureSubjectRDN(INT iSignatureIndex);

char* secureblackbox_xmlverifier_getsignaturesubjectrdn(void* lpObj, int signatureindex);

QString GetSignatureSubjectRDN(int iSignatureIndex);

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureXMLElement(int iSignatureIndex);

Unicode (Windows)
LPWSTR GetSignatureXMLElement(INT iSignatureIndex);

char* secureblackbox_xmlverifier_getsignaturexmlelement(void* lpObj, int signatureindex);

QString GetSignatureXMLElement(int iSignatureIndex);

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

NamespaceCount Property (XMLVerifier Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Unicode (Windows)
INT GetNamespaceCount();
INT SetNamespaceCount(INT iNamespaceCount);

int secureblackbox_xmlverifier_getnamespacecount(void* lpObj);
int secureblackbox_xmlverifier_setnamespacecount(void* lpObj, int iNamespaceCount);

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (XMLVerifier Class)

A user-defined prefix value of a namespace.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, const char* lpszNamespacePrefix);

Unicode (Windows)
LPWSTR GetNamespacePrefix(INT iNamespaceIndex);
INT SetNamespacePrefix(INT iNamespaceIndex, LPCWSTR lpszNamespacePrefix);

char* secureblackbox_xmlverifier_getnamespaceprefix(void* lpObj, int namespaceindex);
int secureblackbox_xmlverifier_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

Default Value

""

Remarks

A user-defined prefix value of a namespace.

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

This property is not available at design time.

Data Type

String

NamespaceURI Property (XMLVerifier Class)

A user-defined URI value of a namespace.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, const char* lpszNamespaceURI);

Unicode (Windows)
LPWSTR GetNamespaceURI(INT iNamespaceIndex);
INT SetNamespaceURI(INT iNamespaceIndex, LPCWSTR lpszNamespaceURI);

char* secureblackbox_xmlverifier_getnamespaceuri(void* lpObj, int namespaceindex);
int secureblackbox_xmlverifier_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Default Value

""

Remarks

A user-defined URI value of a namespace.

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

This property is not available at design time.

Data Type

String

Close Method (XMLVerifier Class)

Closes an opened document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close(int bSaveChanges);

Unicode (Windows)
INT Close(BOOL bSaveChanges);

int secureblackbox_xmlverifier_close(void* lpObj, int bSaveChanges);

int Close(bool bSaveChanges);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (XMLVerifier Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_xmlverifier_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (XMLVerifier Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_xmlverifier_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetInnerXML Method (XMLVerifier Class)

Get the inner XML content of the selected XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInnerXML(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetInnerXML(LPCWSTR lpszXPath);

char* secureblackbox_xmlverifier_getinnerxml(void* lpObj, const char* lpszXPath);

QString GetInnerXML(const QString& qsXPath);

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetOuterXML Method (XMLVerifier Class)

Get the outer XML content of the selected XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOuterXML(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetOuterXML(LPCWSTR lpszXPath);

char* secureblackbox_xmlverifier_getouterxml(void* lpObj, const char* lpszXPath);

QString GetOuterXML(const QString& qsXPath);

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetTextContent Method (XMLVerifier Class)

Get the text content of the selected XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTextContent(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetTextContent(LPCWSTR lpszXPath);

char* secureblackbox_xmlverifier_gettextcontent(void* lpObj, const char* lpszXPath);

QString GetTextContent(const QString& qsXPath);

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Open Method (XMLVerifier Class)

Opens a document for verifying or removing signatures.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int secureblackbox_xmlverifier_open(void* lpObj);

int Open();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Revalidate Method (XMLVerifier Class)

Revalidates a signature in accordance with current settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Revalidate(int iIndex, int bDetached);

Unicode (Windows)
INT Revalidate(INT iIndex, BOOL bDetached);

int secureblackbox_xmlverifier_revalidate(void* lpObj, int iIndex, int bDetached);

int Revalidate(int iIndex, bool bDetached);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInnerXML Method (XMLVerifier Class)

Set the inner XML content of the selected XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInnerXML(const char* lpszXPath, const char* lpszValue);

Unicode (Windows)
INT SetInnerXML(LPCWSTR lpszXPath, LPCWSTR lpszValue);

int secureblackbox_xmlverifier_setinnerxml(void* lpObj, const char* lpszXPath, const char* lpszValue);

int SetInnerXML(const QString& qsXPath, const QString& qsValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetTextContent Method (XMLVerifier Class)

Set the text content of the selected XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetTextContent(const char* lpszXPath, const char* lpszValue);

Unicode (Windows)
INT SetTextContent(LPCWSTR lpszXPath, LPCWSTR lpszValue);

int secureblackbox_xmlverifier_settextcontent(void* lpObj, const char* lpszXPath, const char* lpszValue);

int SetTextContent(const QString& qsXPath, const QString& qsValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Unsign Method (XMLVerifier Class)

Deletes a signature from the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unsign(int iSigIndex);

Unicode (Windows)
INT Unsign(INT iSigIndex);

int secureblackbox_xmlverifier_unsign(void* lpObj, int iSigIndex);

int Unsign(int iSigIndex);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Verify Method (XMLVerifier Class)

Verifies a signed XML document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Verify();

Unicode (Windows)
INT Verify();

int secureblackbox_xmlverifier_verify(void* lpObj);

int Verify();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyDetached Method (XMLVerifier Class)

Verifies a detached signature over external XML data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyDetached();

Unicode (Windows)
INT VerifyDetached();

int secureblackbox_xmlverifier_verifydetached(void* lpObj);

int VerifyDetached();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DocumentLoaded Event (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentLoaded(XMLVerifierDocumentLoadedEventParams *e);

typedef struct {
  int Cancel;
  int reserved;
} XMLVerifierDocumentLoadedEventParams;


Unicode (Windows)
virtual INT FireDocumentLoaded(XMLVerifierDocumentLoadedEventParams *e);

typedef struct {
  BOOL Cancel;
  INT reserved;
} XMLVerifierDocumentLoadedEventParams;

#define EID_XMLVERIFIER_DOCUMENTLOADED 1

virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);

class XMLVerifierDocumentLoadedEventParams {
public:
  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DocumentLoaded(XMLVerifierDocumentLoadedEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireDocumentLoaded(XMLVerifierDocumentLoadedEventParams *e) {...}

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 (XMLVerifier Class)

Information about errors during signature verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(XMLVerifierErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} XMLVerifierErrorEventParams;


Unicode (Windows)
virtual INT FireError(XMLVerifierErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} XMLVerifierErrorEventParams;

#define EID_XMLVERIFIER_ERROR 2

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class XMLVerifierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMLVerifierErrorEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireError(XMLVerifierErrorEventParams *e) {...}

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 (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(XMLVerifierNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} XMLVerifierNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(XMLVerifierNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} XMLVerifierNotificationEventParams;

#define EID_XMLVERIFIER_NOTIFICATION 3

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class XMLVerifierNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(XMLVerifierNotificationEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireNotification(XMLVerifierNotificationEventParams *e) {...}

Remarks

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

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

ReferenceValidated Event (XMLVerifier Class)

Marks the end of a reference validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReferenceValidated(XMLVerifierReferenceValidatedEventParams *e);

typedef struct {
  int ReferenceIndex;
  const char *ID;
  const char *URI;
  const char *RefType;
  int DigestValid;
  int reserved;
} XMLVerifierReferenceValidatedEventParams;


Unicode (Windows)
virtual INT FireReferenceValidated(XMLVerifierReferenceValidatedEventParams *e);

typedef struct {
  INT ReferenceIndex;
  LPCWSTR ID;
  LPCWSTR URI;
  LPCWSTR RefType;
  BOOL DigestValid;
  INT reserved;
} XMLVerifierReferenceValidatedEventParams;

#define EID_XMLVERIFIER_REFERENCEVALIDATED 4

virtual INT SECUREBLACKBOX_CALL FireReferenceValidated(INT &iReferenceIndex, LPSTR &lpszID, LPSTR &lpszURI, LPSTR &lpszRefType, BOOL &bDigestValid);

class XMLVerifierReferenceValidatedEventParams {
public:
  int ReferenceIndex();

  const QString &ID();

  const QString &URI();

  const QString &RefType();

  bool DigestValid();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReferenceValidated(XMLVerifierReferenceValidatedEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireReferenceValidated(XMLVerifierReferenceValidatedEventParams *e) {...}

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 (XMLVerifier Class)

Asks the application to resolve a reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResolveReference(XMLVerifierResolveReferenceEventParams *e);

typedef struct {
  int ReferenceIndex;
  const char *URI;
  int reserved;
} XMLVerifierResolveReferenceEventParams;


Unicode (Windows)
virtual INT FireResolveReference(XMLVerifierResolveReferenceEventParams *e);

typedef struct {
  INT ReferenceIndex;
  LPCWSTR URI;
  INT reserved;
} XMLVerifierResolveReferenceEventParams;

#define EID_XMLVERIFIER_RESOLVEREFERENCE 5

virtual INT SECUREBLACKBOX_CALL FireResolveReference(INT &iReferenceIndex, LPSTR &lpszURI);

class XMLVerifierResolveReferenceEventParams {
public:
  int ReferenceIndex();

  const QString &URI();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResolveReference(XMLVerifierResolveReferenceEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireResolveReference(XMLVerifierResolveReferenceEventParams *e) {...}

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 (XMLVerifier Class)

Signifies the start of signature validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureFound(XMLVerifierSignatureFoundEventParams *e);

typedef struct {
  int Index;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int CertFound;
  int ValidateSignature;
  int ValidateChain;
  int reserved;
} XMLVerifierSignatureFoundEventParams;


Unicode (Windows)
virtual INT FireSignatureFound(XMLVerifierSignatureFoundEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL CertFound;
  BOOL ValidateSignature;
  BOOL ValidateChain;
  INT reserved;
} XMLVerifierSignatureFoundEventParams;

#define EID_XMLVERIFIER_SIGNATUREFOUND 6

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);

class XMLVerifierSignatureFoundEventParams {
public:
  int Index();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureFound(XMLVerifierSignatureFoundEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireSignatureFound(XMLVerifierSignatureFoundEventParams *e) {...}

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

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

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

SignatureValidated Event (XMLVerifier Class)

Reports the signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureValidated(XMLVerifierSignatureValidatedEventParams *e);

typedef struct {
  int SigIndex;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int ValidationResult;
  int reserved;
} XMLVerifierSignatureValidatedEventParams;


Unicode (Windows)
virtual INT FireSignatureValidated(XMLVerifierSignatureValidatedEventParams *e);

typedef struct {
  INT SigIndex;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  INT ValidationResult;
  INT reserved;
} XMLVerifierSignatureValidatedEventParams;

#define EID_XMLVERIFIER_SIGNATUREVALIDATED 7

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iSigIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);

class XMLVerifierSignatureValidatedEventParams {
public:
  int SigIndex();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureValidated(XMLVerifierSignatureValidatedEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireSignatureValidated(XMLVerifierSignatureValidatedEventParams *e) {...}

Remarks

This event is fired when the complete XML signature validation process is finished. IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:

Config Settings (XMLVerifier Class)

XMLVerifier Config Settings

Base Config Settings