XMLSig Class

Properties   Methods   Events   Config Settings   Errors  

The XMLSig class is used to sign XML and verify signed XML.

Syntax

XMLSig

Remarks

The XMLSig component provides an easy to use API for signing and verifying signed XML. The Sign method will create signed XML with an enveloped signature. The VerifySignature method will attempt to verify the signature(s) within a XML document.

Sign

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The References property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set Certificate to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call Sign to sign the XML.

The following properties are applicable when calling this method:

• CanonicalizationMethod
• Certificate (required)
• References (required)
• SignatureXPath
• SigningAlgorithm

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

Verify a Signature

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the XMLElement field must be set to the location of the XML element to which the signature applies. The URI field may contain data helpful to locating the XML element.

The XMLElement field specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

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

The canonicalization method applied to the signature.

Syntax

• C++
• C
• Qt

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

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

CM_C14N(0), 
CM_C14NCOMMENTS(1), 
CM_C14N11(2), 
CM_C14N11COMMENTS(3), 
CM_EXC_C14N(4), 
CM_EXC_C14NCOMMENTS(5)

int ipworksencrypt_xmlsig_getcanonicalizationmethod(void* lpObj);
int ipworksencrypt_xmlsig_setcanonicalizationmethod(void* lpObj, int iCanonicalizationMethod);

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

Default Value

0

Remarks

This property specifies the canonicalization method that is applied to the signature. This may be set before calling Sign. This will be set automatically after calling VerifySignature. Possible values are:

This property is not available at design time.

Data Type

Integer

Certificate Property (XMLSig Class)

The certificate used for signing.

Syntax

• C++
• C
• Qt

IPWorksEncryptCertificate* GetCertificate();
int SetCertificate(IPWorksEncryptCertificate* val);

char* ipworksencrypt_xmlsig_getcerteffectivedate(void* lpObj);

char* ipworksencrypt_xmlsig_getcertexpirationdate(void* lpObj);

char* ipworksencrypt_xmlsig_getcertextendedkeyusage(void* lpObj);

char* ipworksencrypt_xmlsig_getcertfingerprint(void* lpObj);

char* ipworksencrypt_xmlsig_getcertfingerprintsha1(void* lpObj);

char* ipworksencrypt_xmlsig_getcertfingerprintsha256(void* lpObj);

char* ipworksencrypt_xmlsig_getcertissuer(void* lpObj);

char* ipworksencrypt_xmlsig_getcertprivatekey(void* lpObj);

int ipworksencrypt_xmlsig_getcertprivatekeyavailable(void* lpObj);

char* ipworksencrypt_xmlsig_getcertprivatekeycontainer(void* lpObj);

char* ipworksencrypt_xmlsig_getcertpublickey(void* lpObj);

char* ipworksencrypt_xmlsig_getcertpublickeyalgorithm(void* lpObj);

int ipworksencrypt_xmlsig_getcertpublickeylength(void* lpObj);

char* ipworksencrypt_xmlsig_getcertserialnumber(void* lpObj);

char* ipworksencrypt_xmlsig_getcertsignaturealgorithm(void* lpObj);

int ipworksencrypt_xmlsig_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_xmlsig_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworksencrypt_xmlsig_getcertstorepassword(void* lpObj);
int ipworksencrypt_xmlsig_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworksencrypt_xmlsig_getcertstoretype(void* lpObj);
int ipworksencrypt_xmlsig_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworksencrypt_xmlsig_getcertsubjectaltnames(void* lpObj);

char* ipworksencrypt_xmlsig_getcertthumbprintmd5(void* lpObj);

char* ipworksencrypt_xmlsig_getcertthumbprintsha1(void* lpObj);

char* ipworksencrypt_xmlsig_getcertthumbprintsha256(void* lpObj);

char* ipworksencrypt_xmlsig_getcertusage(void* lpObj);

int ipworksencrypt_xmlsig_getcertusageflags(void* lpObj);

char* ipworksencrypt_xmlsig_getcertversion(void* lpObj);

char* ipworksencrypt_xmlsig_getcertsubject(void* lpObj);
int ipworksencrypt_xmlsig_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworksencrypt_xmlsig_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_xmlsig_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QString GetCertEffectiveDate();

QString GetCertExpirationDate();

QString GetCertExtendedKeyUsage();

QString GetCertFingerprint();

QString GetCertFingerprintSHA1();

QString GetCertFingerprintSHA256();

QString GetCertIssuer();

QString GetCertPrivateKey();

bool GetCertPrivateKeyAvailable();

QString GetCertPrivateKeyContainer();

QString GetCertPublicKey();

QString GetCertPublicKeyAlgorithm();

int GetCertPublicKeyLength();

QString GetCertSerialNumber();

QString GetCertSignatureAlgorithm();

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

QString GetCertSubjectAltNames();

QString GetCertThumbprintMD5();

QString GetCertThumbprintSHA1();

QString GetCertThumbprintSHA256();

QString GetCertUsage();

int GetCertUsageFlags();

QString GetCertVersion();

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Remarks

This property specifies a certificate with private key.

This must be set before calling Sign.

Data Type

IPWorksEncryptCertificate

HMACKey Property (XMLSig Class)

The HMAC key used with the 'HMAC-SHA1' signing algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHMACKey(char* &lpHMACKey, int &lenHMACKey);
int SetHMACKey(const char* lpHMACKey, int lenHMACKey);

Unicode (Windows)
INT GetHMACKey(LPSTR &lpHMACKey, INT &lenHMACKey);
INT SetHMACKey(LPCSTR lpHMACKey, INT lenHMACKey);

int ipworksencrypt_xmlsig_gethmackey(void* lpObj, char** lpHMACKey, int* lenHMACKey);
int ipworksencrypt_xmlsig_sethmackey(void* lpObj, const char* lpHMACKey, int lenHMACKey);

QByteArray GetHMACKey();
int SetHMACKey(QByteArray qbaHMACKey);

Default Value

""

Remarks

This property defines the HMAC key to be used when SigningAlgorithm is set to "HMAC-SHA1". This must be set before calling before calling Sign.

This property is also applicable when calling VerifySignature. This may be set before calling VerifySignature or from within the SignatureInfo event.

This property is not available at design time.

Data Type

Binary String

InputFile Property (XMLSig Class)

The XML file to process.

Syntax

• C++
• C
• Qt

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

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

char* ipworksencrypt_xmlsig_getinputfile(void* lpObj);
int ipworksencrypt_xmlsig_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputXML Property (XMLSig Class)

The XML to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputXML();
int SetInputXML(const char* lpszInputXML);

Unicode (Windows)
LPWSTR GetInputXML();
INT SetInputXML(LPCWSTR lpszInputXML);

char* ipworksencrypt_xmlsig_getinputxml(void* lpObj);
int ipworksencrypt_xmlsig_setinputxml(void* lpObj, const char* lpszInputXML);

QString GetInputXML();
int SetInputXML(QString qsInputXML);

Default Value

""

Remarks

This property specifies the XML to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFile Property (XMLSig Class)

The output file.

Syntax

• C++
• C
• Qt

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

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

char* ipworksencrypt_xmlsig_getoutputfile(void* lpObj);
int ipworksencrypt_xmlsig_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputXML Property (XMLSig Class)

The output XML after processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputXML();
int SetOutputXML(const char* lpszOutputXML);

Unicode (Windows)
LPWSTR GetOutputXML();
INT SetOutputXML(LPCWSTR lpszOutputXML);

char* ipworksencrypt_xmlsig_getoutputxml(void* lpObj);
int ipworksencrypt_xmlsig_setoutputxml(void* lpObj, const char* lpszOutputXML);

QString GetOutputXML();
int SetOutputXML(QString qsOutputXML);

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

Overwrite Property (XMLSig Class)

Indicates whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworksencrypt_xmlsig_getoverwrite(void* lpObj);
int ipworksencrypt_xmlsig_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

References Property (XMLSig Class)

A collection of references.

Syntax

• C++
• C
• Qt

IPWorksEncryptList<IPWorksEncryptXMLSigReference>* GetReferences();
int SetReferences(IPWorksEncryptList<IPWorksEncryptXMLSigReference>* val);

int ipworksencrypt_xmlsig_getreferencecount(void* lpObj);
int ipworksencrypt_xmlsig_setreferencecount(void* lpObj, int iReferenceCount);

char* ipworksencrypt_xmlsig_getreferencehashalgorithm(void* lpObj, int referenceindex);
int ipworksencrypt_xmlsig_setreferencehashalgorithm(void* lpObj, int referenceindex, const char* lpszReferenceHashAlgorithm);

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

char* ipworksencrypt_xmlsig_getreferencetransformalgorithms(void* lpObj, int referenceindex);
int ipworksencrypt_xmlsig_setreferencetransformalgorithms(void* lpObj, int referenceindex, const char* lpszReferenceTransformAlgorithms);

char* ipworksencrypt_xmlsig_getreferenceuri(void* lpObj, int referenceindex);
int ipworksencrypt_xmlsig_setreferenceuri(void* lpObj, int referenceindex, const char* lpszReferenceURI);

char* ipworksencrypt_xmlsig_getreferencexmlelement(void* lpObj, int referenceindex);
int ipworksencrypt_xmlsig_setreferencexmlelement(void* lpObj, int referenceindex, const char* lpszReferenceXMLElement);

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

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

QString GetReferenceHashValue(int iReferenceIndex);

QString GetReferenceTransformAlgorithms(int iReferenceIndex);
int SetReferenceTransformAlgorithms(int iReferenceIndex, QString qsReferenceTransformAlgorithms);

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

QString GetReferenceXMLElement(int iReferenceIndex);
int SetReferenceXMLElement(int iReferenceIndex, QString qsReferenceXMLElement);

Remarks

This property holds a collection of reference to sign or verify. This must be populated before calling Sign. This will be populated by the class when calling VerifySignature and is accessible from within the SignatureInfo event.

This property is not available at design time.

Data Type

IPWorksEncryptXMLSigReference

SignatureXPath Property (XMLSig Class)

The XPath of the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureXPath();
int SetSignatureXPath(const char* lpszSignatureXPath);

Unicode (Windows)
LPWSTR GetSignatureXPath();
INT SetSignatureXPath(LPCWSTR lpszSignatureXPath);

char* ipworksencrypt_xmlsig_getsignaturexpath(void* lpObj);
int ipworksencrypt_xmlsig_setsignaturexpath(void* lpObj, const char* lpszSignatureXPath);

QString GetSignatureXPath();
int SetSignatureXPath(QString qsSignatureXPath);

Default Value

"/"

Remarks

This property specifies the XPath in the XML where the signature will be placed.

This may be set before calling Sign. This property will be populated when calling VerifySignature.

The default value is "/".

This property is not available at design time.

Data Type

String

SignerCert Property (XMLSig Class)

The certificate used for signature verification.

Syntax

• C++
• C
• Qt

IPWorksEncryptCertificate* GetSignerCert();
int SetSignerCert(IPWorksEncryptCertificate* val);

char* ipworksencrypt_xmlsig_getsignercerteffectivedate(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertexpirationdate(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertextendedkeyusage(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertfingerprint(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertfingerprintsha1(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertfingerprintsha256(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertissuer(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertprivatekey(void* lpObj);

int ipworksencrypt_xmlsig_getsignercertprivatekeyavailable(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertprivatekeycontainer(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertpublickey(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertpublickeyalgorithm(void* lpObj);

int ipworksencrypt_xmlsig_getsignercertpublickeylength(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertserialnumber(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertsignaturealgorithm(void* lpObj);

int ipworksencrypt_xmlsig_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksencrypt_xmlsig_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

char* ipworksencrypt_xmlsig_getsignercertstorepassword(void* lpObj);
int ipworksencrypt_xmlsig_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

int ipworksencrypt_xmlsig_getsignercertstoretype(void* lpObj);
int ipworksencrypt_xmlsig_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

char* ipworksencrypt_xmlsig_getsignercertsubjectaltnames(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertthumbprintmd5(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertthumbprintsha1(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertthumbprintsha256(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertusage(void* lpObj);

int ipworksencrypt_xmlsig_getsignercertusageflags(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertversion(void* lpObj);

char* ipworksencrypt_xmlsig_getsignercertsubject(void* lpObj);
int ipworksencrypt_xmlsig_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

int ipworksencrypt_xmlsig_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksencrypt_xmlsig_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QString GetSignerCertEffectiveDate();

QString GetSignerCertExpirationDate();

QString GetSignerCertExtendedKeyUsage();

QString GetSignerCertFingerprint();

QString GetSignerCertFingerprintSHA1();

QString GetSignerCertFingerprintSHA256();

QString GetSignerCertIssuer();

QString GetSignerCertPrivateKey();

bool GetSignerCertPrivateKeyAvailable();

QString GetSignerCertPrivateKeyContainer();

QString GetSignerCertPublicKey();

QString GetSignerCertPublicKeyAlgorithm();

int GetSignerCertPublicKeyLength();

QString GetSignerCertSerialNumber();

QString GetSignerCertSignatureAlgorithm();

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

QString GetSignerCertSubjectAltNames();

QString GetSignerCertThumbprintMD5();

QString GetSignerCertThumbprintSHA1();

QString GetSignerCertThumbprintSHA256();

QString GetSignerCertUsage();

int GetSignerCertUsageFlags();

QString GetSignerCertVersion();

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Remarks

This property specifies a certificate for signature verification.

This may be set from within the SignatureInfo event after calling VerifySignature. If the signed XML already includes a public key to use for verification, then this property will be automatically populated and does not need to be set. Check the SignatureInfo event to determine if a public key was parsed from the signed XML. If a public key was not automatically parsed, set this property to the signer's certificate from within the event.

Data Type

IPWorksEncryptCertificate

SigningAlgorithm Property (XMLSig Class)

The signing algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm);

Unicode (Windows)
LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);

char* ipworksencrypt_xmlsig_getsigningalgorithm(void* lpObj);
int ipworksencrypt_xmlsig_setsigningalgorithm(void* lpObj, const char* lpszSigningAlgorithm);

QString GetSigningAlgorithm();
int SetSigningAlgorithm(QString qsSigningAlgorithm);

Default Value

""

Remarks

This property specifies the signing algorithm.

This may be set before calling Sign. This value will be set after calling VerifySignature. Possible values are:

• "RSA-SHA1" (default)
• "RSA-SHA256"
• "DSA-SHA1"
• "HMAC-SHA1"

This property is not available at design time.

Data Type

String

Config Method (XMLSig 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* ipworksencrypt_xmlsig_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.

DoEvents Method (XMLSig Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksencrypt_xmlsig_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

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

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_xmlsig_reset(void* lpObj);

int Reset();

Remarks

When called, the component will reset all of its properties to their default values.

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

SetInputStream Method (XMLSig Class)

Sets the stream from which the class will read data to sign or verify.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_xmlsig_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data to sign or verify. If an input stream is set before calling Sign or VerifySignature, the data is read from the input stream instead of from the InputFile or InputXML properties.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

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

SetOutputStream Method (XMLSig Class)

The stream to which the class will write the signed or verified XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(IPWorksEncryptStream* sOutputStream);

int ipworksencrypt_xmlsig_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);

int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Remarks

This method sets the stream to which the class will write the signed or verified XML. If an output stream is set before calling Sign or VerifySignature, the class will write the data to the output stream instead of populating OutputXML or writing to OutputFile.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

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

Signs the XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworksencrypt_xmlsig_sign(void* lpObj);

int Sign();

Remarks

This methods signs the XML.

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The References property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set Certificate to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call Sign to sign the XML.

The following properties are applicable when calling this method:

• CanonicalizationMethod
• Certificate (required)
• References (required)
• SignatureXPath
• SigningAlgorithm

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

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

VerifySignature Method (XMLSig Class)

Verifies signed XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworksencrypt_xmlsig_verifysignature(void* lpObj);

int VerifySignature();

Remarks

This method verifies signatures contained in the XML.

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the XMLElement field must be set to the location of the XML element to which the signature applies. The URI field may contain data helpful to locating the XML element.

The XMLElement field specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLSIG_ERROR 1

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

class XMLSigErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

Progress Event (XMLSig Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(XMLSigProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int Operation;
  int IsEOF;
  int reserved;
} XMLSigProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(XMLSigProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT Operation;
  BOOL IsEOF;
  INT reserved;
} XMLSigProgressEventParams;

#define EID_XMLSIG_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed, INT &iOperation, BOOL &bIsEOF);

class XMLSigProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

  int Operation();

  bool IsEOF();
  void SetIsEOF(bool bIsEOF);

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

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

// Or, subclass XMLSig and override this emitter function.
virtual int FireProgress(XMLSigProgressEventParams *e) {...}

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

SignatureInfo Event (XMLSig Class)

Fired when a signature is found.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureInfo(XMLSigSignatureInfoEventParams *e);

typedef struct {
  const char *SignatureId;
  int SignerCertParsed;
  int reserved;
} XMLSigSignatureInfoEventParams;


Unicode (Windows)
virtual INT FireSignatureInfo(XMLSigSignatureInfoEventParams *e);

typedef struct {
  LPCWSTR SignatureId;
  BOOL SignerCertParsed;
  INT reserved;
} XMLSigSignatureInfoEventParams;

#define EID_XMLSIG_SIGNATUREINFO 3

virtual INT IPWORKSENCRYPT_CALL FireSignatureInfo(LPSTR &lpszSignatureId, BOOL &bSignerCertParsed);

class XMLSigSignatureInfoEventParams {
public:
  const QString &SignatureId();

  bool SignerCertParsed();

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

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

// Or, subclass XMLSig and override this emitter function.
virtual int FireSignatureInfo(XMLSigSignatureInfoEventParams *e) {...}

Remarks

This event fires when calling VerifySignature for each signature found within the XML document.

SignatureId is the id of the signature.

SignerCertParsed indicates whether the signer's certificate was automatically parsed from the signed XML.

Verification Notes

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the XMLElement field must be set to the location of the XML element to which the signature applies. The URI field may contain data helpful to locating the XML element.

The XMLElement field specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

Status Event (XMLSig Class)

Provides information about the current operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(XMLSigStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} XMLSigStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(XMLSigStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} XMLSigStatusEventParams;

#define EID_XMLSIG_STATUS 4

virtual INT IPWORKSENCRYPT_CALL FireStatus(LPSTR &lpszMessage);

class XMLSigStatusEventParams {
public:
  const QString &Message();

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

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

// Or, subclass XMLSig and override this emitter function.
virtual int FireStatus(XMLSigStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEncryptCertificate (declared in ipworksencrypt.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

XMLSigReference Type

This type defines information about the reference.

Syntax

IPWorksEncryptXMLSigReference (declared in ipworksencrypt.h)

Remarks

This type defines information about the reference including the location within the document (XMLElement), TransformAlgorithms, HashAlgorithm, and URI.

Fields

Constructors

XMLSigReference()

XMLSigReference(const char* lpszXMLElement, const char* lpszURI, const char* lpszHashAlgorithm, const char* lpszTransformAlgorithms, const char* lpszHashValue)

IPWorksEncryptList Type

Syntax

IPWorksEncryptList<T> (declared in ipworksencrypt.h)

Remarks

IPWorksEncryptList 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 XMLSig class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The XMLSig class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the XMLSig class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (XMLSig Class)

XMLSig Config Settings

<root>
  <node1>
    <ds:Signature>...</ds:Signature>
  </node1>
  <node2></node2>
  <node3></node3>
</root>

<root>
  <node1></node1>
  <ds:Signature>...</ds:Signature>
  <node2></node2>
  <node3></node3>
</root>

Base Config Settings

Trappable Errors (XMLSig Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XMLSig Errors

XML Errors