XMLSigner Class

Properties   Methods   Events   Config Settings   Errors  

The XMLSigner class provides a simple interface for digitally signing XML documents according to the XML-Signature Syntax and Processing specification.

Syntax

XMLSigner

Remarks

XMLSigner implements the most basic XML-SIG signature standard. While this format is still quite widely used, it lacks important facilities that have been gaining popularity in recent years, such as strict chain validation, support for trust environments, and long-term signatures (also known as XAdES). If you are looking for XAdES support, please consider using the alternative XAdESSigner component.

To sign XML data with XMLSigner, you need to specify the data to be signed using the References property first, then select the signature type and signature method type (signature or MAC). References are individual pieces of the XML document that are covered by the signature. You can choose to sign the whole document or one or more individual elements.

Set the path to the file to be signed via the InputFile (or InputBytes). Signed data will be saved in OutputBytes, or the OutputFile if provided.

Finally, call the Sign method to generate a signature and save the signed data. XMLSigner supports the two product-wide external signing approaches for signing with remote private keys: use SignExternal or SignAsyncBegin to do this as required. XmlSigner.InputFile = "data.xml"; XmlSigner.OutputFile = "data-signed.xml"; XmlSigner.SigningCertificate = CertMgr.Certificate; XmlSigner.Sign();

Property List

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

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.

CanonicalizationMethod Property (XMLSigner Class)

Specifies XML canonicalization method to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCanonicalizationMethod();
int SetCanonicalizationMethod(int iCanonicalizationMethod);

Unicode (Windows)
INT GetCanonicalizationMethod();
INT SetCanonicalizationMethod(INT iCanonicalizationMethod);

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_xmlsigner_getcanonicalizationmethod(void* lpObj);
int secureblackbox_xmlsigner_setcanonicalizationmethod(void* lpObj, int iCanonicalizationMethod);

int GetCanonicalizationMethod();
int SetCanonicalizationMethod(int iCanonicalizationMethod);

Default Value

1

Remarks

Use this property to specify the method for XML canonicalization of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

Supported canonicalization methods:

Data Type

Integer

DataBytes Property (XMLSigner 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_xmlsigner_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_xmlsigner_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 (XMLSigner 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_xmlsigner_getdatafile(void* lpObj);
int secureblackbox_xmlsigner_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 (XMLSigner 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_xmlsigner_getdatatype(void* lpObj);
int secureblackbox_xmlsigner_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 (XMLSigner 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_xmlsigner_getdatauri(void* lpObj);
int secureblackbox_xmlsigner_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 (XMLSigner 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_xmlsigner_getencoding(void* lpObj);
int secureblackbox_xmlsigner_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

ExternalCrypto Property (XMLSigner Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_xmlsigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_xmlsigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_xmlsigner_getexternalcryptodata(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_xmlsigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_xmlsigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_xmlsigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_xmlsigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_xmlsigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_xmlsigner_getexternalcryptomode(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_xmlsigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_xmlsigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (XMLSigner 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_xmlsigner_getfipsmode(void* lpObj);
int secureblackbox_xmlsigner_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

HashAlgorithm Property (XMLSigner Class)

Specifies the hash algorithm to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_xmlsigner_gethashalgorithm(void* lpObj);
int secureblackbox_xmlsigner_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

"SHA256"

Remarks

Use this property to set the hash algorithm for signature calculation.

Supported values:

Data Type

String

InputBytes Property (XMLSigner 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_xmlsigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_xmlsigner_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 (XMLSigner Class)

Specifies the XML document to be signed.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_xmlsigner_getinputfile(void* lpObj);
int secureblackbox_xmlsigner_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

Provide a path to the XML file to be signed.

Data Type

String

OutputBytes Property (XMLSigner 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_xmlsigner_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 (XMLSigner Class)

A file where the signed document is to 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_xmlsigner_getoutputfile(void* lpObj);
int secureblackbox_xmlsigner_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Provide a path to the file where the signed document is to be saved.

Data Type

String

References Property (XMLSigner Class)

A list of references to the data to be signed.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxXMLReference>* GetReferences();

int secureblackbox_xmlsigner_getreferencecount(void* lpObj);
int secureblackbox_xmlsigner_setreferencecount(void* lpObj, int iReferenceCount);

int secureblackbox_xmlsigner_getreferenceautogenerateelementid(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceautogenerateelementid(void* lpObj, int referenceindex, int bReferenceAutoGenerateElementId);

int secureblackbox_xmlsigner_getreferencecanonicalizationmethod(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencecanonicalizationmethod(void* lpObj, int referenceindex, int iReferenceCanonicalizationMethod);

char* secureblackbox_xmlsigner_getreferencecustomelementid(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencecustomelementid(void* lpObj, int referenceindex, const char* lpszReferenceCustomElementId);

int secureblackbox_xmlsigner_getreferencedigestvalue(void* lpObj, int referenceindex, char** lpReferenceDigestValue, int* lenReferenceDigestValue);
int secureblackbox_xmlsigner_setreferencedigestvalue(void* lpObj, int referenceindex, const char* lpReferenceDigestValue, int lenReferenceDigestValue);

int64 secureblackbox_xmlsigner_getreferencehandle(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencehandle(void* lpObj, int referenceindex, int64 lReferenceHandle);

char* secureblackbox_xmlsigner_getreferencehashalgorithm(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencehashalgorithm(void* lpObj, int referenceindex, const char* lpszReferenceHashAlgorithm);

int secureblackbox_xmlsigner_getreferencehasuri(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencehasuri(void* lpObj, int referenceindex, int bReferenceHasURI);

char* secureblackbox_xmlsigner_getreferenceid(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceid(void* lpObj, int referenceindex, const char* lpszReferenceID);

char* secureblackbox_xmlsigner_getreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceInclusiveNamespacesPrefixList);

char* secureblackbox_xmlsigner_getreferencereferencetype(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencereferencetype(void* lpObj, int referenceindex, const char* lpszReferenceReferenceType);

int secureblackbox_xmlsigner_getreferencetargetdata(void* lpObj, int referenceindex, char** lpReferenceTargetData, int* lenReferenceTargetData);
int secureblackbox_xmlsigner_setreferencetargetdata(void* lpObj, int referenceindex, const char* lpReferenceTargetData, int lenReferenceTargetData);

int secureblackbox_xmlsigner_getreferencetargettype(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencetargettype(void* lpObj, int referenceindex, int iReferenceTargetType);

char* secureblackbox_xmlsigner_getreferencetargetxmlelement(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencetargetxmlelement(void* lpObj, int referenceindex, const char* lpszReferenceTargetXMLElement);

char* secureblackbox_xmlsigner_getreferenceuri(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceuri(void* lpObj, int referenceindex, const char* lpszReferenceURI);

int secureblackbox_xmlsigner_getreferenceusebase64transform(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceusebase64transform(void* lpObj, int referenceindex, int bReferenceUseBase64Transform);

int secureblackbox_xmlsigner_getreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex, int bReferenceUseEnvelopedSignatureTransform);

int secureblackbox_xmlsigner_getreferenceusexpathfilter2transform(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceusexpathfilter2transform(void* lpObj, int referenceindex, int bReferenceUseXPathFilter2Transform);

int secureblackbox_xmlsigner_getreferenceusexpathtransform(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferenceusexpathtransform(void* lpObj, int referenceindex, int bReferenceUseXPathTransform);

int secureblackbox_xmlsigner_getreferencevalidationresult(void* lpObj, int referenceindex);

char* secureblackbox_xmlsigner_getreferencexpathexpression(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencexpathexpression(void* lpObj, int referenceindex, const char* lpszReferenceXPathExpression);

char* secureblackbox_xmlsigner_getreferencexpathfilter2expressions(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencexpathfilter2expressions(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Expressions);

char* secureblackbox_xmlsigner_getreferencexpathfilter2filters(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencexpathfilter2filters(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Filters);

char* secureblackbox_xmlsigner_getreferencexpathfilter2prefixlist(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencexpathfilter2prefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2PrefixList);

char* secureblackbox_xmlsigner_getreferencexpathprefixlist(void* lpObj, int referenceindex);
int secureblackbox_xmlsigner_setreferencexpathprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathPrefixList);

int GetReferenceCount();
int SetReferenceCount(int iReferenceCount);

bool GetReferenceAutoGenerateElementId(int iReferenceIndex);
int SetReferenceAutoGenerateElementId(int iReferenceIndex, bool bReferenceAutoGenerateElementId);

int GetReferenceCanonicalizationMethod(int iReferenceIndex);
int SetReferenceCanonicalizationMethod(int iReferenceIndex, int iReferenceCanonicalizationMethod);

QString GetReferenceCustomElementId(int iReferenceIndex);
int SetReferenceCustomElementId(int iReferenceIndex, QString qsReferenceCustomElementId);

QByteArray GetReferenceDigestValue(int iReferenceIndex);
int SetReferenceDigestValue(int iReferenceIndex, QByteArray qbaReferenceDigestValue);

qint64 GetReferenceHandle(int iReferenceIndex);
int SetReferenceHandle(int iReferenceIndex, qint64 lReferenceHandle);

QString GetReferenceHashAlgorithm(int iReferenceIndex);
int SetReferenceHashAlgorithm(int iReferenceIndex, QString qsReferenceHashAlgorithm);

bool GetReferenceHasURI(int iReferenceIndex);
int SetReferenceHasURI(int iReferenceIndex, bool bReferenceHasURI);

QString GetReferenceID(int iReferenceIndex);
int SetReferenceID(int iReferenceIndex, QString qsReferenceID);

QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);
int SetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex, QString qsReferenceInclusiveNamespacesPrefixList);

QString GetReferenceReferenceType(int iReferenceIndex);
int SetReferenceReferenceType(int iReferenceIndex, QString qsReferenceReferenceType);

QByteArray GetReferenceTargetData(int iReferenceIndex);
int SetReferenceTargetData(int iReferenceIndex, QByteArray qbaReferenceTargetData);

int GetReferenceTargetType(int iReferenceIndex);
int SetReferenceTargetType(int iReferenceIndex, int iReferenceTargetType);

QString GetReferenceTargetXMLElement(int iReferenceIndex);
int SetReferenceTargetXMLElement(int iReferenceIndex, QString qsReferenceTargetXMLElement);

QString GetReferenceURI(int iReferenceIndex);
int SetReferenceURI(int iReferenceIndex, QString qsReferenceURI);

bool GetReferenceUseBase64Transform(int iReferenceIndex);
int SetReferenceUseBase64Transform(int iReferenceIndex, bool bReferenceUseBase64Transform);

bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);
int SetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex, bool bReferenceUseEnvelopedSignatureTransform);

bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);
int SetReferenceUseXPathFilter2Transform(int iReferenceIndex, bool bReferenceUseXPathFilter2Transform);

bool GetReferenceUseXPathTransform(int iReferenceIndex);
int SetReferenceUseXPathTransform(int iReferenceIndex, bool bReferenceUseXPathTransform);

bool GetReferenceValidationResult(int iReferenceIndex);

QString GetReferenceXPathExpression(int iReferenceIndex);
int SetReferenceXPathExpression(int iReferenceIndex, QString qsReferenceXPathExpression);

QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);
int SetReferenceXPathFilter2Expressions(int iReferenceIndex, QString qsReferenceXPathFilter2Expressions);

QString GetReferenceXPathFilter2Filters(int iReferenceIndex);
int SetReferenceXPathFilter2Filters(int iReferenceIndex, QString qsReferenceXPathFilter2Filters);

QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);
int SetReferenceXPathFilter2PrefixList(int iReferenceIndex, QString qsReferenceXPathFilter2PrefixList);

QString GetReferenceXPathPrefixList(int iReferenceIndex);
int SetReferenceXPathPrefixList(int iReferenceIndex, QString qsReferenceXPathPrefixList);

Remarks

Electronic signature is computed over a set of data pieces. Each piece of data to be signed is specified by a reference.

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

Data Type

SecureBlackboxXMLReference

SignatureType Property (XMLSigner Class)

The signature type to employ when signing the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureType();
int SetSignatureType(int iSignatureType);

Unicode (Windows)
INT GetSignatureType();
INT SetSignatureType(INT iSignatureType);

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

int secureblackbox_xmlsigner_getsignaturetype(void* lpObj);
int secureblackbox_xmlsigner_setsignaturetype(void* lpObj, int iSignatureType);

int GetSignatureType();
int SetSignatureType(int iSignatureType);

Default Value

4

Remarks

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

Supported values:

Data Type

Integer

SigningCertificate Property (XMLSigner Class)

The certificate to be used for signing.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);

int secureblackbox_xmlsigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

int64 secureblackbox_xmlsigner_getsigningcerthandle(void* lpObj);
int secureblackbox_xmlsigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);

QByteArray GetSigningCertBytes();

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SigningChain Property (XMLSigner Class)

The signing certificate chain.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain();
int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_xmlsigner_getsigningchaincount(void* lpObj);
int secureblackbox_xmlsigner_setsigningchaincount(void* lpObj, int iSigningChainCount);

int secureblackbox_xmlsigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

int64 secureblackbox_xmlsigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_xmlsigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

QByteArray GetSigningChainBytes(int iSigningChainIndex);

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

XMLElement Property (XMLSigner Class)

Specifies the XML element where to save the signature data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXMLElement();
int SetXMLElement(const char* lpszXMLElement);

Unicode (Windows)
LPWSTR GetXMLElement();
INT SetXMLElement(LPCWSTR lpszXMLElement);

char* secureblackbox_xmlsigner_getxmlelement(void* lpObj);
int secureblackbox_xmlsigner_setxmlelement(void* lpObj, const char* lpszXMLElement);

QString GetXMLElement();
int SetXMLElement(QString qsXMLElement);

Default Value

""

Remarks

This property specifies the XML element where to save the electronic signature.

Supported values are:

Data Type

String

AddDataReference Method (XMLSigner Class)

Creates a new XML reference to the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddDataReference(const char* lpszDataURI, const char* lpData, int lenData);

Unicode (Windows)
INT AddDataReference(LPCWSTR lpszDataURI, LPCSTR lpData, INT lenData);

int secureblackbox_xmlsigner_adddatareference(void* lpObj, const char* lpszDataURI, const char* lpData, int lenData);

int AddDataReference(const QString& qsDataURI, QByteArray qbaData);

Remarks

Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.

This method uses HashAlgorithm property to specify the hash algorithm of the reference.

The method returns the index of the new reference entry in the References collection.

Error Handling (C++)

This method returns an Integer 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.

AddKnownNamespace Method (XMLSigner 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_xmlsigner_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.)

AddReference Method (XMLSigner Class)

Creates a new XML reference to the specified XML element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddReference(const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId);

Unicode (Windows)
INT AddReference(LPCWSTR lpszTargetXmlElement, LPCWSTR lpszCustomId, BOOL bAutoGenerateId);

int secureblackbox_xmlsigner_addreference(void* lpObj, const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId);

int AddReference(const QString& qsTargetXmlElement, const QString& qsCustomId, bool bAutoGenerateId);

Remarks

Use this method to add a reference to a particular XML element.

The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.

This method uses CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm of the reference.

The method returns the index of the new reference entry in the References collection.

Error Handling (C++)

This method returns an Integer 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.

Config Method (XMLSigner 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_xmlsigner_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 (XMLSigner 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_xmlsigner_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.

ExtractAsyncData Method (XMLSigner Class)

Extracts user data from the DC signing service response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExtractAsyncData(const char* lpszAsyncReply);

Unicode (Windows)
LPWSTR ExtractAsyncData(LPCWSTR lpszAsyncReply);

char* secureblackbox_xmlsigner_extractasyncdata(void* lpObj, const char* lpszAsyncReply);

QString ExtractAsyncData(const QString& qsAsyncReply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

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 (XMLSigner 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_xmlsigner_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 (XMLSigner 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_xmlsigner_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 (XMLSigner 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_xmlsigner_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.

Reset Method (XMLSigner Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SetInnerXML Method (XMLSigner 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_xmlsigner_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 (XMLSigner 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_xmlsigner_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.)

Sign Method (XMLSigner Class)

Signs an XML document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int secureblackbox_xmlsigner_sign(void* lpObj);

int Sign();

Remarks

Call this method to generate a signature over an 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.)

SignAsyncBegin Method (XMLSigner Class)

Initiates the asynchronous signing operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SignAsyncBegin();

Unicode (Windows)
LPWSTR SignAsyncBegin();

char* secureblackbox_xmlsigner_signasyncbegin(void* lpObj);

QString SignAsyncBegin();

Remarks

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

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

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

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

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

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

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.

SignAsyncEnd Method (XMLSigner Class)

Completes the asynchronous signing operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignAsyncEnd(const char* lpszAsyncReply);

Unicode (Windows)
INT SignAsyncEnd(LPCWSTR lpszAsyncReply);

int secureblackbox_xmlsigner_signasyncend(void* lpObj, const char* lpszAsyncReply);

int SignAsyncEnd(const QString& qsAsyncReply);

Remarks

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

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

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

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

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

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

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

SignExternal Method (XMLSigner Class)

Signs the document using an external signing facility.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignExternal();

Unicode (Windows)
INT SignExternal();

int secureblackbox_xmlsigner_signexternal(void* lpObj);

int SignExternal();

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

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

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

Error Event (XMLSigner Class)

Reports the details of signing errors.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLSIGNER_ERROR 1

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

class XMLSignerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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.

ExternalSign Event (XMLSigner Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(XMLSignerExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} XMLSignerExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(XMLSignerExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} XMLSignerExternalSignEventParams;

#define EID_XMLSIGNER_EXTERNALSIGN 2

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

class XMLSignerExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

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

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

// Or, subclass XMLSigner and override this emitter function.
virtual int FireExternalSign(XMLSignerExternalSignEventParams *e) {...}

Remarks

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

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

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

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

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

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

FormatElement Event (XMLSigner Class)

Reports the XML element that is currently being processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFormatElement(XMLSignerFormatElementEventParams *e);

typedef struct {
  char *StartTagWhitespace;
  char *EndTagWhitespace;
  int Level;
  const char *Path;
  int HasChildElements;
  int reserved;
} XMLSignerFormatElementEventParams;


Unicode (Windows)
virtual INT FireFormatElement(XMLSignerFormatElementEventParams *e);

typedef struct {
  LPWSTR StartTagWhitespace;
  LPWSTR EndTagWhitespace;
  INT Level;
  LPCWSTR Path;
  BOOL HasChildElements;
  INT reserved;
} XMLSignerFormatElementEventParams;

#define EID_XMLSIGNER_FORMATELEMENT 3

virtual INT SECUREBLACKBOX_CALL FireFormatElement(LPSTR &lpszStartTagWhitespace, LPSTR &lpszEndTagWhitespace, INT &iLevel, LPSTR &lpszPath, BOOL &bHasChildElements);

class XMLSignerFormatElementEventParams {
public:
  const QString &StartTagWhitespace();
  void SetStartTagWhitespace(const QString &qsStartTagWhitespace);

  const QString &EndTagWhitespace();
  void SetEndTagWhitespace(const QString &qsEndTagWhitespace);

  int Level();

  const QString &Path();

  bool HasChildElements();

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

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

// Or, subclass XMLSigner and override this emitter function.
virtual int FireFormatElement(XMLSignerFormatElementEventParams *e) {...}

Remarks

Path and Level specify the path to the XML element being processed and its nesting level, respectively.

HasChildElements specify if processed XML element has child elements.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

FormatText Event (XMLSigner Class)

Reports XML text that is currently being processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFormatText(XMLSignerFormatTextEventParams *e);

typedef struct {
  char *Text;
  int TextType;
  int Level;
  const char *Path;
  int reserved;
} XMLSignerFormatTextEventParams;


Unicode (Windows)
virtual INT FireFormatText(XMLSignerFormatTextEventParams *e);

typedef struct {
  LPWSTR Text;
  INT TextType;
  INT Level;
  LPCWSTR Path;
  INT reserved;
} XMLSignerFormatTextEventParams;

#define EID_XMLSIGNER_FORMATTEXT 4

virtual INT SECUREBLACKBOX_CALL FireFormatText(LPSTR &lpszText, INT &iTextType, INT &iLevel, LPSTR &lpszPath);

class XMLSignerFormatTextEventParams {
public:
  const QString &Text();
  void SetText(const QString &qsText);

  int TextType();

  int Level();

  const QString &Path();

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

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

// Or, subclass XMLSigner and override this emitter function.
virtual int FireFormatText(XMLSignerFormatTextEventParams *e) {...}

Remarks

TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

Notification Event (XMLSigner Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLSIGNER_NOTIFICATION 5

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

class XMLSignerNotificationEventParams {
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(XMLSignerNotificationEventParams *e);

// Or, subclass XMLSigner and override this emitter function.
virtual int FireNotification(XMLSignerNotificationEventParams *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:

ResolveReference Event (XMLSigner Class)

Asks the application to resolve a reference.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLSIGNER_RESOLVEREFERENCE 6

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

class XMLSignerResolveReferenceEventParams {
public:
  int ReferenceIndex();

  const QString &URI();

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

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

// Or, subclass XMLSigner and override this emitter function.
virtual int FireResolveReference(XMLSignerResolveReferenceEventParams *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.

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.

Fields

Constructors

Certificate()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

ExternalCrypto()

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.

Fields

Constructors

XMLReference()

XMLReference(const char* lpszID)

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

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 XMLSigner class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (XMLSigner Class)

XMLSigner Config Settings