XMLEncrypt Class

Properties   Methods   Events   Config Settings   Errors  

The XMLEncrypt class is used to encrypt and decrypt XML.

Syntax

XMLEncrypt

Remarks

The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The Encrypt method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting the EncryptedDataDetail* properties. The Decrypt method will decrypt the XML document.

The class supports encrypting and decrypting with a shared SymmetricKey, and also using asymmetric encryption to encrypt the SymmetricKey (session key) via the RecipientCert* and Cer* properties.

Encrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• EncryptedDataDetail*
• RecipientCert*
• KeyName

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.

Decrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo event fires once for each encrypted element when Decrypt is called.

If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• Certificate

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.

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.

Certificate Property (XMLEncrypt Class)

The certificate used for decryption.

Syntax

• C++
• C
• Qt

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

char* ipworksencrypt_xmlencrypt_getcerteffectivedate(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertexpirationdate(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertextendedkeyusage(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertfingerprint(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertfingerprintsha1(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertfingerprintsha256(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertissuer(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertprivatekey(void* lpObj);

int ipworksencrypt_xmlencrypt_getcertprivatekeyavailable(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertprivatekeycontainer(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertpublickey(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertpublickeyalgorithm(void* lpObj);

int ipworksencrypt_xmlencrypt_getcertpublickeylength(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertserialnumber(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertsignaturealgorithm(void* lpObj);

int ipworksencrypt_xmlencrypt_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_xmlencrypt_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworksencrypt_xmlencrypt_getcertstorepassword(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworksencrypt_xmlencrypt_getcertstoretype(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworksencrypt_xmlencrypt_getcertsubjectaltnames(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertthumbprintmd5(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertthumbprintsha1(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertthumbprintsha256(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertusage(void* lpObj);

int ipworksencrypt_xmlencrypt_getcertusageflags(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertversion(void* lpObj);

char* ipworksencrypt_xmlencrypt_getcertsubject(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworksencrypt_xmlencrypt_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_xmlencrypt_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.

If the encrypted XML contains an encrypted key this property specifies the certificate with private key to be used to decrypt the key. This is applicable when calling Decrypt.

Data Type

IPWorksEncryptCertificate

EncryptedDataDetails Property (XMLEncrypt Class)

A collection of encrypted data details.

Syntax

• C++
• C
• Qt

IPWorksEncryptList<IPWorksEncryptXMLEncryptedDataDetail>* GetEncryptedDataDetails();
int SetEncryptedDataDetails(IPWorksEncryptList<IPWorksEncryptXMLEncryptedDataDetail>* val);

int ipworksencrypt_xmlencrypt_getencrypteddatadetailcount(void* lpObj);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailcount(void* lpObj, int iEncryptedDataDetailCount);

char* ipworksencrypt_xmlencrypt_getencrypteddatadetailid(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailid(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailId);

char* ipworksencrypt_xmlencrypt_getencrypteddatadetailmimetype(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailmimetype(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailMIMEType);

int ipworksencrypt_xmlencrypt_getencrypteddatadetailscope(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailscope(void* lpObj, int encrypteddatadetailindex, int iEncryptedDataDetailScope);

char* ipworksencrypt_xmlencrypt_getencrypteddatadetailxmlelement(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailxmlelement(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailXMLElement);

int GetEncryptedDataDetailCount();
int SetEncryptedDataDetailCount(int iEncryptedDataDetailCount);

QString GetEncryptedDataDetailId(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailId(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailId);

QString GetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailMIMEType);

int GetEncryptedDataDetailScope(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailScope(int iEncryptedDataDetailIndex, int iEncryptedDataDetailScope);

QString GetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailXMLElement);

Remarks

This property holds a collection of details about the XML elements to be encrypted. This may be populated before calling Encrypt. If this is not populated, then the entire XML document will be encrypted.

This property is not available at design time.

Data Type

IPWorksEncryptXMLEncryptedDataDetail

EncryptingAlgorithm Property (XMLEncrypt Class)

Then encryption algorithm used when encrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);

char* ipworksencrypt_xmlencrypt_getencryptingalgorithm(void* lpObj);
int ipworksencrypt_xmlencrypt_setencryptingalgorithm(void* lpObj, const char* lpszEncryptingAlgorithm);

QString GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(QString qsEncryptingAlgorithm);

Default Value

"3DES"

Remarks

This property specifies the encryption algorithm to use when encrypting. Possible values are:

• "3DES" (default)
• "DES"
• "AES128"
• "AES192"
• "AES256"

Data Type

String

InputFile Property (XMLEncrypt 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_xmlencrypt_getinputfile(void* lpObj);
int ipworksencrypt_xmlencrypt_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 (XMLEncrypt 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_xmlencrypt_getinputxml(void* lpObj);
int ipworksencrypt_xmlencrypt_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 (XMLEncrypt 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_xmlencrypt_getoutputfile(void* lpObj);
int ipworksencrypt_xmlencrypt_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 (XMLEncrypt 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_xmlencrypt_getoutputxml(void* lpObj);
int ipworksencrypt_xmlencrypt_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 (XMLEncrypt 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_xmlencrypt_getoverwrite(void* lpObj);
int ipworksencrypt_xmlencrypt_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

RecipientCert Property (XMLEncrypt Class)

The certificate used for encryption.

Syntax

• C++
• C
• Qt

IPWorksEncryptCertificate* GetRecipientCert();
int SetRecipientCert(IPWorksEncryptCertificate* val);

char* ipworksencrypt_xmlencrypt_getrecipientcerteffectivedate(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertexpirationdate(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertextendedkeyusage(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertfingerprint(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertfingerprintsha1(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertfingerprintsha256(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertissuer(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertprivatekey(void* lpObj);

int ipworksencrypt_xmlencrypt_getrecipientcertprivatekeyavailable(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertprivatekeycontainer(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertpublickey(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertpublickeyalgorithm(void* lpObj);

int ipworksencrypt_xmlencrypt_getrecipientcertpublickeylength(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertserialnumber(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertsignaturealgorithm(void* lpObj);

int ipworksencrypt_xmlencrypt_getrecipientcertstore(void* lpObj, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksencrypt_xmlencrypt_setrecipientcertstore(void* lpObj, const char* lpRecipientCertStore, int lenRecipientCertStore);

char* ipworksencrypt_xmlencrypt_getrecipientcertstorepassword(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertstorepassword(void* lpObj, const char* lpszRecipientCertStorePassword);

int ipworksencrypt_xmlencrypt_getrecipientcertstoretype(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertstoretype(void* lpObj, int iRecipientCertStoreType);

char* ipworksencrypt_xmlencrypt_getrecipientcertsubjectaltnames(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertthumbprintmd5(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertthumbprintsha1(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertthumbprintsha256(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertusage(void* lpObj);

int ipworksencrypt_xmlencrypt_getrecipientcertusageflags(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertversion(void* lpObj);

char* ipworksencrypt_xmlencrypt_getrecipientcertsubject(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertsubject(void* lpObj, const char* lpszRecipientCertSubject);

int ipworksencrypt_xmlencrypt_getrecipientcertencoded(void* lpObj, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksencrypt_xmlencrypt_setrecipientcertencoded(void* lpObj, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

QString GetRecipientCertEffectiveDate();

QString GetRecipientCertExpirationDate();

QString GetRecipientCertExtendedKeyUsage();

QString GetRecipientCertFingerprint();

QString GetRecipientCertFingerprintSHA1();

QString GetRecipientCertFingerprintSHA256();

QString GetRecipientCertIssuer();

QString GetRecipientCertPrivateKey();

bool GetRecipientCertPrivateKeyAvailable();

QString GetRecipientCertPrivateKeyContainer();

QString GetRecipientCertPublicKey();

QString GetRecipientCertPublicKeyAlgorithm();

int GetRecipientCertPublicKeyLength();

QString GetRecipientCertSerialNumber();

QString GetRecipientCertSignatureAlgorithm();

QByteArray GetRecipientCertStore();
int SetRecipientCertStore(QByteArray qbaRecipientCertStore);

QString GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(QString qsRecipientCertStorePassword);

int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType);

QString GetRecipientCertSubjectAltNames();

QString GetRecipientCertThumbprintMD5();

QString GetRecipientCertThumbprintSHA1();

QString GetRecipientCertThumbprintSHA256();

QString GetRecipientCertUsage();

int GetRecipientCertUsageFlags();

QString GetRecipientCertVersion();

QString GetRecipientCertSubject();
int SetRecipientCertSubject(QString qsRecipientCertSubject);

QByteArray GetRecipientCertEncoded();
int SetRecipientCertEncoded(QByteArray qbaRecipientCertEncoded);

Remarks

This property specifies a certificate for encryption.

If specified, the SymmetricKey will be encrypted and included as an encrypted key in the XML. This is applicable when calling Encrypt.

Data Type

IPWorksEncryptCertificate

SymmetricKey Property (XMLEncrypt Class)

The symmetric key used to encrypt and decrypt the XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSymmetricKey(char* &lpSymmetricKey, int &lenSymmetricKey);
int SetSymmetricKey(const char* lpSymmetricKey, int lenSymmetricKey);

Unicode (Windows)
INT GetSymmetricKey(LPSTR &lpSymmetricKey, INT &lenSymmetricKey);
INT SetSymmetricKey(LPCSTR lpSymmetricKey, INT lenSymmetricKey);

int ipworksencrypt_xmlencrypt_getsymmetrickey(void* lpObj, char** lpSymmetricKey, int* lenSymmetricKey);
int ipworksencrypt_xmlencrypt_setsymmetrickey(void* lpObj, const char* lpSymmetricKey, int lenSymmetricKey);

QByteArray GetSymmetricKey();
int SetSymmetricKey(QByteArray qbaSymmetricKey);

Default Value

""

Remarks

This property specifies the symmetric key used to encrypt and decrypt the XML.

Encrypt Notes

When calling Encrypt if the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the SymmetricKey allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the SymmetricKey is required by the recipient.

If the RecipientCert* properties are set and SymmetricKey is left empty, then a SymmetricKey value will automatically be generated by the class when Encrypt is called.

When calling Encrypt if the RecipientCert* properties are are not set, then the SymmetricKey value must be known by the recipient before the message can be decrypted.

Decrypt Notes

When calling Decrypt if the data contains an encrypted key the class will attempt to use the certificate specified by the Cert* properties to decrypt the encrypted key and this property is ignored.

When calling Decrypt if the data does not contain an encrypted key then SymmetricKey must be set either before calling Decrypt, or within the EncryptedDataInfo event.

Legal Key and Block Sizes (in bits)

This property is not available at design time.

Data Type

Binary String

UseOAEP Property (XMLEncrypt Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseOAEP();
int SetUseOAEP(int bUseOAEP);

Unicode (Windows)
BOOL GetUseOAEP();
INT SetUseOAEP(BOOL bUseOAEP);

int ipworksencrypt_xmlencrypt_getuseoaep(void* lpObj);
int ipworksencrypt_xmlencrypt_setuseoaep(void* lpObj, int bUseOAEP);

bool GetUseOAEP();
int SetUseOAEP(bool bUseOAEP);

Default Value

FALSE

Remarks

This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the SymmetricKey with the certificate specified by RecipientCert. It is only applicable when calling Encrypt and RecipientCert is specified.

By default this value is False and the class will use PKCS1.

Data Type

Boolean

Config Method (XMLEncrypt Class)

This method 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_xmlencrypt_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.

Decrypt Method (XMLEncrypt Class)

Decrypts the XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksencrypt_xmlencrypt_decrypt(void* lpObj);

int Decrypt();

Remarks

This method decrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo event fires once for each encrypted element when Decrypt is called.

If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• Certificate

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

DoEvents Method (XMLEncrypt 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_xmlencrypt_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.)

Encrypt Method (XMLEncrypt Class)

Encrypts the XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworksencrypt_xmlencrypt_encrypt(void* lpObj);

int Encrypt();

Remarks

This method encrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• EncryptedDataDetail*
• RecipientCert*
• KeyName

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

Reset Method (XMLEncrypt Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_xmlencrypt_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 (XMLEncrypt Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

• C++
• C
• Qt

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

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

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

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data to encrypt or decrypt. If an input stream is set before calling Encrypt or Decrypt, 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 (XMLEncrypt Class)

The stream to which the class will write the encrypted or decrypted XML.

Syntax

• C++
• C
• Qt

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

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

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

int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Remarks

This method sets the stream to which the class will write the encrypted or decrypted XML. If an output stream is set before calling Encrypt or Decrypt, 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.)

EncryptedDataInfo Event (XMLEncrypt Class)

Fired once for each encrypted element when Decrypt is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e);

typedef struct {
  const char *EncryptedDataId;
  int Scope;
  const char *MIMEType;
  int reserved;
} XMLEncryptEncryptedDataInfoEventParams;


Unicode (Windows)
virtual INT FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e);

typedef struct {
  LPCWSTR EncryptedDataId;
  INT Scope;
  LPCWSTR MIMEType;
  INT reserved;
} XMLEncryptEncryptedDataInfoEventParams;

#define EID_XMLENCRYPT_ENCRYPTEDDATAINFO 1

virtual INT IPWORKSENCRYPT_CALL FireEncryptedDataInfo(LPSTR &lpszEncryptedDataId, INT &iScope, LPSTR &lpszMIMEType);

class XMLEncryptEncryptedDataInfoEventParams {
public:
  const QString &EncryptedDataId();

  int Scope();

  const QString &MIMEType();

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

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

// Or, subclass XMLEncrypt and override this emitter function.
virtual int FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e) {...}

Remarks

This event fires once for each encrypted element in the XML document when Decrypt is called. The parameters of this event provide information about the encrypted data. Additionally, the KeyName setting may be queried to identify the encryption key. SymmetricKey may be set from within this event.

EncryptedDataId is the Id of the encrypted data (if any).

Scope indicates the scope of the encrypted data. This defines whether the entire XML element was encrypted, or only the content. Possible values are:

MIMEType holds the MIME type of the encrypted data (if any). For example: "image/png".

Error Event (XMLEncrypt Class)

This event is fired for information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPT_ERROR 2

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

class XMLEncryptErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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 the Error Codes section.

Progress Event (XMLEncrypt Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPT_PROGRESS 3

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

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

// Or, subclass XMLEncrypt and override this emitter function.
virtual int FireProgress(XMLEncryptProgressEventParams *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.

Status Event (XMLEncrypt Class)

Provides information about the current operation.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPT_STATUS 4

virtual INT IPWORKSENCRYPT_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

// Or, subclass XMLEncrypt and override this emitter function.
virtual int FireStatus(XMLEncryptStatusEventParams *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()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X509 public key.

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

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA1, or SHA256 thumbprint of the certificate to load in a "Thumbprint=value" format.

XMLEncryptedDataDetail Type

This type defines details about the data to be encrypted.

Syntax

IPWorksEncryptXMLEncryptedDataDetail (declared in ipworksencrypt.h)

Remarks

This type defines details about the data to be encrypted. The element to encrypt is defined by .

Fields

Constructors

XMLEncryptedDataDetail()

XMLEncryptedDataDetail(const char* lpszId, const char* lpszXMLElement, int iScope, const char* lpszMIMEType)

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

int GetCount() {}

int SetCount() {}

T* Get(int index) {}

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

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The XMLEncrypt 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 XMLEncrypt 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 (XMLEncrypt Class)

XMLEnc Config Settings

Base Config Settings

Trappable Errors (XMLEncrypt 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.

XMLEnc Errors

XML Errors