XMLVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The XMLVerifier class provides simplified XML signature validation capabilities.

Syntax

XMLVerifier

Remarks

Use this control to validate XML-SIG signatures. XMLVerifier is capable of validating the integrity of the references covered by the signature and the integrity of the signature itself, using the certificate contained in the signature or provided from the user' code.

Note that this component only validates the cryptographic aspects of the signatures, but does not perform any chain of trust validation. As such, it is the task of your code to ensure that the signing certificate is good for its purpose and is trusted in your environment.

If you are looking to validate certificate trust in addition to the cryptographic capabilities, please consider using XAdESVerifier. XAdESVerifier provides full support for advanced signature ecosystem, including revocation and Trusted List checking, timing checks, and chain of trust validation.

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

Certificates Property (XMLVerifier Class)

A collection of certificates included in the electronic signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetCertificates();

int secureblackbox_xmlverifier_getcertcount(void* lpObj);

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

int secureblackbox_xmlverifier_getcertca(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertcerttype(void* lpObj, int certindex);

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

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

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

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

int64 secureblackbox_xmlverifier_getcerthandle(void* lpObj, int certindex);

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

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

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

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

int secureblackbox_xmlverifier_getcertkeybits(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertkeyusage(void* lpObj, int certindex);

int secureblackbox_xmlverifier_getcertkeyvalid(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertocspnocheck(void* lpObj, int certindex);

int secureblackbox_xmlverifier_getcertorigin(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertprivatekeybytes(void* lpObj, int certindex, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);

int secureblackbox_xmlverifier_getcertprivatekeyexists(void* lpObj, int certindex);

int secureblackbox_xmlverifier_getcertprivatekeyextractable(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertqualified(void* lpObj, int certindex);

int secureblackbox_xmlverifier_getcertqualifiedstatements(void* lpObj, int certindex);

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

int secureblackbox_xmlverifier_getcertselfsigned(void* lpObj, int certindex);

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

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

int secureblackbox_xmlverifier_getcertsource(void* lpObj, int certindex);

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

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

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

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

int secureblackbox_xmlverifier_getcertvalid(void* lpObj, int certindex);

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

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

int GetCertCount();

QByteArray GetCertBytes(int iCertIndex);

bool GetCertCA(int iCertIndex);

QByteArray GetCertCAKeyID(int iCertIndex);

int GetCertCertType(int iCertIndex);

QString GetCertCRLDistributionPoints(int iCertIndex);

QString GetCertCurve(int iCertIndex);

QString GetCertFingerprint(int iCertIndex);

QString GetCertFriendlyName(int iCertIndex);

qint64 GetCertHandle(int iCertIndex);

QString GetCertHashAlgorithm(int iCertIndex);

QString GetCertIssuer(int iCertIndex);

QString GetCertIssuerRDN(int iCertIndex);

QString GetCertKeyAlgorithm(int iCertIndex);

int GetCertKeyBits(int iCertIndex);

QString GetCertKeyFingerprint(int iCertIndex);

int GetCertKeyUsage(int iCertIndex);

bool GetCertKeyValid(int iCertIndex);

QString GetCertOCSPLocations(int iCertIndex);

bool GetCertOCSPNoCheck(int iCertIndex);

int GetCertOrigin(int iCertIndex);

QString GetCertPolicyIDs(int iCertIndex);

QByteArray GetCertPrivateKeyBytes(int iCertIndex);

bool GetCertPrivateKeyExists(int iCertIndex);

bool GetCertPrivateKeyExtractable(int iCertIndex);

QByteArray GetCertPublicKeyBytes(int iCertIndex);

bool GetCertQualified(int iCertIndex);

int GetCertQualifiedStatements(int iCertIndex);

QString GetCertQualifiers(int iCertIndex);

bool GetCertSelfSigned(int iCertIndex);

QByteArray GetCertSerialNumber(int iCertIndex);

QString GetCertSigAlgorithm(int iCertIndex);

int GetCertSource(int iCertIndex);

QString GetCertSubject(int iCertIndex);

QString GetCertSubjectAlternativeName(int iCertIndex);

QByteArray GetCertSubjectKeyID(int iCertIndex);

QString GetCertSubjectRDN(int iCertIndex);

bool GetCertValid(int iCertIndex);

QString GetCertValidFrom(int iCertIndex);

QString GetCertValidTo(int iCertIndex);

Remarks

This property includes a collection of certificates of the currently selected info.

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

Data Type

SecureBlackboxCertificate

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

KnownCertificates Property (XMLVerifier Class)

Additional certificates for chain validation.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

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

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

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

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

QByteArray GetKnownCertBytes(int iKnownCertIndex);

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

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

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 has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (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

References Property (XMLVerifier Class)

References covered by the signature.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxXMLReference>* GetReferences();

int secureblackbox_xmlverifier_getreferencecount(void* lpObj);

int secureblackbox_xmlverifier_getreferencecanonicalizationmethod(void* lpObj, int referenceindex);

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

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

int64 secureblackbox_xmlverifier_getreferencehandle(void* lpObj, int referenceindex);

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

int secureblackbox_xmlverifier_getreferencehasuri(void* lpObj, int referenceindex);

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

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

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

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

int secureblackbox_xmlverifier_getreferencetargettype(void* lpObj, int referenceindex);

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

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

int secureblackbox_xmlverifier_getreferenceusebase64transform(void* lpObj, int referenceindex);

int secureblackbox_xmlverifier_getreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex);

int secureblackbox_xmlverifier_getreferenceusexpathfilter2transform(void* lpObj, int referenceindex);

int secureblackbox_xmlverifier_getreferenceusexpathtransform(void* lpObj, int referenceindex);

int secureblackbox_xmlverifier_getreferencevalidationresult(void* lpObj, int referenceindex);

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

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

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

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

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

int GetReferenceCount();

int GetReferenceCanonicalizationMethod(int iReferenceIndex);

QString GetReferenceCustomElementId(int iReferenceIndex);

QByteArray GetReferenceDigestValue(int iReferenceIndex);

qint64 GetReferenceHandle(int iReferenceIndex);

QString GetReferenceHashAlgorithm(int iReferenceIndex);

bool GetReferenceHasURI(int iReferenceIndex);

QString GetReferenceID(int iReferenceIndex);

QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);

QString GetReferenceReferenceType(int iReferenceIndex);

QByteArray GetReferenceTargetData(int iReferenceIndex);

int GetReferenceTargetType(int iReferenceIndex);

QString GetReferenceTargetXMLElement(int iReferenceIndex);

QString GetReferenceURI(int iReferenceIndex);

bool GetReferenceUseBase64Transform(int iReferenceIndex);

bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);

bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);

bool GetReferenceUseXPathTransform(int iReferenceIndex);

bool GetReferenceValidationResult(int iReferenceIndex);

QString GetReferenceXPathExpression(int iReferenceIndex);

QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);

QString GetReferenceXPathFilter2Filters(int iReferenceIndex);

QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);

QString GetReferenceXPathPrefixList(int iReferenceIndex);

Remarks

Use this property to get the references to the data covered by the signature.

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

Data Type

SecureBlackboxXMLReference

Signatures Property (XMLVerifier Class)

All signatures found in the XML document.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxXMLSignature>* GetSignatures();

int secureblackbox_xmlverifier_getsignaturecount(void* lpObj);

int secureblackbox_xmlverifier_getsignaturecanonicalizationmethod(void* lpObj, int signatureindex);

int secureblackbox_xmlverifier_getsignaturecompatibilityerrors(void* lpObj, int signatureindex);

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

int64 secureblackbox_xmlverifier_getsignaturehandle(void* lpObj, int signatureindex);

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

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

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

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

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

int secureblackbox_xmlverifier_getsignaturesignaturetype(void* lpObj, int signatureindex);

int secureblackbox_xmlverifier_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);

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

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

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

int GetSignatureCount();

int GetSignatureCanonicalizationMethod(int iSignatureIndex);

int GetSignatureCompatibilityErrors(int iSignatureIndex);

QString GetSignatureEntityLabel(int iSignatureIndex);

qint64 GetSignatureHandle(int iSignatureIndex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

QString GetSignatureIssuerRDN(int iSignatureIndex);

QString GetSignatureParentEntity(int iSignatureIndex);

QByteArray GetSignatureSerialNumber(int iSignatureIndex);

QByteArray GetSignatureSignatureBytes(int iSignatureIndex);

int GetSignatureSignatureType(int iSignatureIndex);

int GetSignatureSignatureValidationResult(int iSignatureIndex);

QByteArray GetSignatureSubjectKeyID(int iSignatureIndex);

QString GetSignatureSubjectRDN(int iSignatureIndex);

QString GetSignatureXMLElement(int iSignatureIndex);

Remarks

This property contains a list of all signatures made over the XML document.

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

Data Type

SecureBlackboxXMLSignature

AddKnownNamespace Method (XMLVerifier Class)

Adds known prefix and correspondent namespace URI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddKnownNamespace(const char* lpszPrefix, const char* lpszURI);

Unicode (Windows)
INT AddKnownNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszURI);

int secureblackbox_xmlverifier_addknownnamespace(void* lpObj, const char* lpszPrefix, const char* lpszURI);

int AddKnownNamespace(const QString& qsPrefix, const QString& qsURI);

Remarks

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

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

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 insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

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.

GetSignedData Method (XMLVerifier Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignedData(const char* lpszSigLabel, int iRefIndex);

Unicode (Windows)
INT GetSignedData(LPCWSTR lpszSigLabel, INT iRefIndex);

int secureblackbox_xmlverifier_getsigneddata(void* lpObj, const char* lpszSigLabel, int iRefIndex);

int GetSignedData(const QString& qsSigLabel, int iRefIndex);

Remarks

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

The output can be collected in one of the following ways: either by passing the destination path or stream via OutputFile and OutputStream respectively, or by reading the resulting data bytes from the OutputBytes property after the operation completes.

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

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

Reset Method (XMLVerifier Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_xmlverifier_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

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(const char* lpszSigLabel, int bDetached);

Unicode (Windows)
INT Revalidate(LPCWSTR lpszSigLabel, BOOL bDetached);

int secureblackbox_xmlverifier_revalidate(void* lpObj, const char* lpszSigLabel, int bDetached);

int Revalidate(const QString& qsSigLabel, 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.)

SelectInfo Method (XMLVerifier Class)

Select signature information for a specific entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SelectInfo(const char* lpszEntityLabel, int iInfoType, int bClearSelection);

Unicode (Windows)
INT SelectInfo(LPCWSTR lpszEntityLabel, INT iInfoType, BOOL bClearSelection);

int secureblackbox_xmlverifier_selectinfo(void* lpObj, const char* lpszEntityLabel, int iInfoType, int bClearSelection);

int SelectInfo(const QString& qsEntityLabel, int iInfoType, bool bClearSelection);

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

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(const char* lpszSigLabel);

Unicode (Windows)
INT Unsign(LPCWSTR lpszSigLabel);

int secureblackbox_xmlverifier_unsign(void* lpObj, const char* lpszSigLabel);

int Unsign(const QString& qsSigLabel);

Remarks

Use this method to delete an existing signature from the document. Use SigLabel 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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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

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

ReferenceValidated Event (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 *EntityLabel;
  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 EntityLabel;
  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 &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);

class XMLVerifierSignatureFoundEventParams {
public:
  int Index();

  const QString &EntityLabel();

  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 parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the 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)

Marks the completion of the signature validation routine.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT Index;
  LPCWSTR EntityLabel;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  INT ValidationResult;
  BOOL Cancel;
  INT reserved;
} XMLVerifierSignatureValidatedEventParams;

#define EID_XMLVERIFIER_SIGNATUREVALIDATED 7

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult, BOOL &bCancel);

class XMLVerifierSignatureValidatedEventParams {
public:
  int Index();

  const QString &EntityLabel();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

  bool Cancel();
  void SetCancel(bool bCancel);

  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 upon the completion of the signature validation routine, and reports the respective validation result.

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

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

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

• Bytes
• CA
• CAKeyID
• CertType
• CRLDistributionPoints
• Curve
• Fingerprint
• FriendlyName
• Handle
• HashAlgorithm
• Issuer
• IssuerRDN
• KeyAlgorithm
• KeyBits
• KeyFingerprint
• KeyUsage
• KeyValid
• OCSPLocations
• OCSPNoCheck
• Origin
• PolicyIDs
• PrivateKeyBytes
• PrivateKeyExists
• PrivateKeyExtractable
• PublicKeyBytes
• Qualified
• QualifiedStatements
• Qualifiers
• SelfSigned
• SerialNumber
• SigAlgorithm
• Source
• Subject
• SubjectAlternativeName
• SubjectKeyID
• SubjectRDN
• Valid
• ValidFrom
• ValidTo

Fields

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Constructors

Certificate()

XMLReference Type

Represents an XML reference element.

Syntax

SecureBlackboxXMLReference (declared in secureblackbox.h)

Remarks

XMLReference specifies the digest algorithm and digest value, and, optionally: an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting.

• AutoGenerateElementId
• CanonicalizationMethod
• CustomElementId
• DataObjectDescription
• DataObjectEncoding
• DataObjectIdentifier
• DataObjectMimeType
• DigestValue
• Handle
• HasDataObjectFormat
• HashAlgorithm
• HasURI
• ID
• InclusiveNamespacesPrefixList
• ReferenceType
• TargetData
• TargetType
• TargetXMLElement
• URI
• UseBase64Transform
• UseEnvelopedSignatureTransform
• UseXPathFilter2Transform
• UseXPathTransform
• ValidationResult
• XPathExpression
• XPathFilter2Expressions
• XPathFilter2Filters
• XPathFilter2PrefixList
• XPathPrefixList

Fields

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Constructors

XMLReference()

XMLReference(const char* lpszID)

XMLReference(const char* lpszID, const char* lpszURI)

XMLSignature Type

The component is a container for an XML signature.

Syntax

SecureBlackboxXMLSignature (declared in secureblackbox.h)

Remarks

XML document may include any number of XML signatures. class stores on of them.

• CanonicalizationMethod
• CompatibilityErrors
• EntityLabel
• Handle
• HashAlgorithm
• IssuerRDN
• ParentEntity
• SerialNumber
• SignatureBytes
• SignatureType
• SignatureValidationResult
• SubjectKeyID
• SubjectRDN
• XMLElement

Fields

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Constructors

XMLSignature()

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the XMLVerifier class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (XMLVerifier Class)

XMLVerifier Config Settings