XMLEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The XMLEncryptor class encrypts XML documents.

Syntax

XMLEncryptor

Remarks

XMLEncryptor encrypts XML documents with certificates or generic keys.

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.

Encoding Property (XMLEncryptor 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_xmlencryptor_getencoding(void* lpObj);
int secureblackbox_xmlencryptor_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

EncryptedDataType Property (XMLEncryptor Class)

Specifies the type of the data being encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptedDataType();
int SetEncryptedDataType(int iEncryptedDataType);

Unicode (Windows)
INT GetEncryptedDataType();
INT SetEncryptedDataType(INT iEncryptedDataType);

CXEDT_ELEMENT(0), 
CXEDT_CONTENT(1), 
CXEDT_EXTERNAL(2)

int secureblackbox_xmlencryptor_getencrypteddatatype(void* lpObj);
int secureblackbox_xmlencryptor_setencrypteddatatype(void* lpObj, int iEncryptedDataType);

int GetEncryptedDataType();
int SetEncryptedDataType(int iEncryptedDataType);

Default Value

0

Remarks

This property specifies the data type to be encrypted.

Supported values:

Data Type

Integer

EncryptionKey Property (XMLEncryptor Class)

The symmetric (session) key used to encrypt the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionKey(char* &lpEncryptionKey, int &lenEncryptionKey);
int SetEncryptionKey(const char* lpEncryptionKey, int lenEncryptionKey);

Unicode (Windows)
INT GetEncryptionKey(LPSTR &lpEncryptionKey, INT &lenEncryptionKey);
INT SetEncryptionKey(LPCSTR lpEncryptionKey, INT lenEncryptionKey);

int secureblackbox_xmlencryptor_getencryptionkey(void* lpObj, char** lpEncryptionKey, int* lenEncryptionKey);
int secureblackbox_xmlencryptor_setencryptionkey(void* lpObj, const char* lpEncryptionKey, int lenEncryptionKey);

QByteArray GetEncryptionKey();
int SetEncryptionKey(QByteArray qbaEncryptionKey);

Remarks

Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data.

It is required when the EncryptKey property is disabled. If the EncryptKey property is enabled, and no value is set, the component will generate a random session key (recommended).

This property is not available at design time.

Data Type

Byte Array

EncryptionMethod Property (XMLEncryptor Class)

The encryption method used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionMethod();
int SetEncryptionMethod(const char* lpszEncryptionMethod);

Unicode (Windows)
LPWSTR GetEncryptionMethod();
INT SetEncryptionMethod(LPCWSTR lpszEncryptionMethod);

char* secureblackbox_xmlencryptor_getencryptionmethod(void* lpObj);
int secureblackbox_xmlencryptor_setencryptionmethod(void* lpObj, const char* lpszEncryptionMethod);

QString GetEncryptionMethod();
int SetEncryptionMethod(QString qsEncryptionMethod);

Default Value

"AES256"

Remarks

This property contains the encryption algorithm used to encrypt the XML document.

Supported values:

If UseGCM property is enabled, then supported values are:

Data Type

String

EncryptKey Property (XMLEncryptor Class)

Specifies if the encryption key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptKey();
int SetEncryptKey(int bEncryptKey);

Unicode (Windows)
BOOL GetEncryptKey();
INT SetEncryptKey(BOOL bEncryptKey);

int secureblackbox_xmlencryptor_getencryptkey(void* lpObj);
int secureblackbox_xmlencryptor_setencryptkey(void* lpObj, int bEncryptKey);

bool GetEncryptKey();
int SetEncryptKey(bool bEncryptKey);

Default Value

FALSE

Remarks

Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data.

Data Type

Boolean

ExternalData Property (XMLEncryptor Class)

The data that should be encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalData(char* &lpExternalData, int &lenExternalData);
int SetExternalData(const char* lpExternalData, int lenExternalData);

Unicode (Windows)
INT GetExternalData(LPSTR &lpExternalData, INT &lenExternalData);
INT SetExternalData(LPCSTR lpExternalData, INT lenExternalData);

int secureblackbox_xmlencryptor_getexternaldata(void* lpObj, char** lpExternalData, int* lenExternalData);
int secureblackbox_xmlencryptor_setexternaldata(void* lpObj, const char* lpExternalData, int lenExternalData);

QByteArray GetExternalData();
int SetExternalData(QByteArray qbaExternalData);

Remarks

Use this property to provide the data that should be encrypted if EncryptedDataType property is set to cxedtExternal value.

This property is not available at design time.

Data Type

Byte Array

FIPSMode Property (XMLEncryptor 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_xmlencryptor_getfipsmode(void* lpObj);
int secureblackbox_xmlencryptor_setfipsmode(void* lpObj, int bFIPSMode);

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

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (XMLEncryptor 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_xmlencryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_xmlencryptor_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 (XMLEncryptor Class)

The XML document to be encrypted.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_xmlencryptor_getinputfile(void* lpObj);
int secureblackbox_xmlencryptor_setinputfile(void* lpObj, const char* lpszInputFile);

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

Default Value

""

Remarks

Provide the path to the XML document to be encrypted.

Data Type

String

KeyEncryptionCertBytes Property (XMLEncryptor Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEncryptionCertBytes(char* &lpKeyEncryptionCertBytes, int &lenKeyEncryptionCertBytes);

Unicode (Windows)
INT GetKeyEncryptionCertBytes(LPSTR &lpKeyEncryptionCertBytes, INT &lenKeyEncryptionCertBytes);

int secureblackbox_xmlencryptor_getkeyencryptioncertbytes(void* lpObj, char** lpKeyEncryptionCertBytes, int* lenKeyEncryptionCertBytes);

QByteArray GetKeyEncryptionCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

KeyEncryptionCertHandle Property (XMLEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyEncryptionCertHandle();
int SetKeyEncryptionCertHandle(int64 lKeyEncryptionCertHandle);

Unicode (Windows)
LONG64 GetKeyEncryptionCertHandle();
INT SetKeyEncryptionCertHandle(LONG64 lKeyEncryptionCertHandle);

int64 secureblackbox_xmlencryptor_getkeyencryptioncerthandle(void* lpObj);
int secureblackbox_xmlencryptor_setkeyencryptioncerthandle(void* lpObj, int64 lKeyEncryptionCertHandle);

qint64 GetKeyEncryptionCertHandle();
int SetKeyEncryptionCertHandle(qint64 lKeyEncryptionCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

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

This property is not available at design time.

Data Type

Long64

KeyEncryptionKey Property (XMLEncryptor Class)

The symmetric key used to encrypt a session key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEncryptionKey(char* &lpKeyEncryptionKey, int &lenKeyEncryptionKey);
int SetKeyEncryptionKey(const char* lpKeyEncryptionKey, int lenKeyEncryptionKey);

Unicode (Windows)
INT GetKeyEncryptionKey(LPSTR &lpKeyEncryptionKey, INT &lenKeyEncryptionKey);
INT SetKeyEncryptionKey(LPCSTR lpKeyEncryptionKey, INT lenKeyEncryptionKey);

int secureblackbox_xmlencryptor_getkeyencryptionkey(void* lpObj, char** lpKeyEncryptionKey, int* lenKeyEncryptionKey);
int secureblackbox_xmlencryptor_setkeyencryptionkey(void* lpObj, const char* lpKeyEncryptionKey, int lenKeyEncryptionKey);

QByteArray GetKeyEncryptionKey();
int SetKeyEncryptionKey(QByteArray qbaKeyEncryptionKey);

Remarks

Use this property to provide the encryption symmetric key that will be used to encrypt a session key. It is required when the EncryptKey property is enabled and KeyEncryptionType is set to cxetKeyWrap value.

This property is not available at design time.

Data Type

Byte Array

KeyEncryptionType Property (XMLEncryptor Class)

Specifies how the session key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEncryptionType();
int SetKeyEncryptionType(int iKeyEncryptionType);

Unicode (Windows)
INT GetKeyEncryptionType();
INT SetKeyEncryptionType(INT iKeyEncryptionType);

CXET_KEY_TRANSPORT(0), 
CXET_KEY_WRAP(1)

int secureblackbox_xmlencryptor_getkeyencryptiontype(void* lpObj);
int secureblackbox_xmlencryptor_setkeyencryptiontype(void* lpObj, int iKeyEncryptionType);

int GetKeyEncryptionType();
int SetKeyEncryptionType(int iKeyEncryptionType);

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyTransportMethod Property (XMLEncryptor Class)

Specifies how the session key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyTransportMethod();
int SetKeyTransportMethod(int iKeyTransportMethod);

Unicode (Windows)
INT GetKeyTransportMethod();
INT SetKeyTransportMethod(INT iKeyTransportMethod);

CXKT_RSA15(0), 
CXKT_RSAOAEP(1)

int secureblackbox_xmlencryptor_getkeytransportmethod(void* lpObj);
int secureblackbox_xmlencryptor_setkeytransportmethod(void* lpObj, int iKeyTransportMethod);

int GetKeyTransportMethod();
int SetKeyTransportMethod(int iKeyTransportMethod);

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyWrapMethod Property (XMLEncryptor Class)

The key wrap method used to encrypt the session key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyWrapMethod();
int SetKeyWrapMethod(const char* lpszKeyWrapMethod);

Unicode (Windows)
LPWSTR GetKeyWrapMethod();
INT SetKeyWrapMethod(LPCWSTR lpszKeyWrapMethod);

char* secureblackbox_xmlencryptor_getkeywrapmethod(void* lpObj);
int secureblackbox_xmlencryptor_setkeywrapmethod(void* lpObj, const char* lpszKeyWrapMethod);

QString GetKeyWrapMethod();
int SetKeyWrapMethod(QString qsKeyWrapMethod);

Default Value

"Camellia256"

Remarks

This property specifies the key wrap algorithm used to encrypt the session key.

Supported values:

Data Type

String

OutputBytes Property (XMLEncryptor 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_xmlencryptor_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 (XMLEncryptor Class)

Defines where to save the encrypted XML document.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_xmlencryptor_getoutputfile(void* lpObj);
int secureblackbox_xmlencryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

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

Default Value

""

Remarks

Specifies the path where the encrypted XML document should be saved.

Data Type

String

UseGCM Property (XMLEncryptor Class)

Specifies if GCM mode is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseGCM();
int SetUseGCM(int bUseGCM);

Unicode (Windows)
BOOL GetUseGCM();
INT SetUseGCM(BOOL bUseGCM);

int secureblackbox_xmlencryptor_getusegcm(void* lpObj);
int secureblackbox_xmlencryptor_setusegcm(void* lpObj, int bUseGCM);

bool GetUseGCM();
int SetUseGCM(bool bUseGCM);

Default Value

FALSE

Remarks

Use this property to enable Galois/Counter Mode (GCM) mode for AES encryption method.

Data Type

Boolean

XMLNode Property (XMLEncryptor Class)

Defines the XML element to encrypt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXMLNode();
int SetXMLNode(const char* lpszXMLNode);

Unicode (Windows)
LPWSTR GetXMLNode();
INT SetXMLNode(LPCWSTR lpszXMLNode);

char* secureblackbox_xmlencryptor_getxmlnode(void* lpObj);
int secureblackbox_xmlencryptor_setxmlnode(void* lpObj, const char* lpszXMLNode);

QString GetXMLNode();
int SetXMLNode(QString qsXMLNode);

Default Value

""

Remarks

Defines the XML element/node to encrypt or in case if cxedtExternal encryption data type is used where to save the encrypted data.

Supported values are:

Data Type

String

NamespaceCount Property (XMLEncryptor Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_xmlencryptor_getnamespacecount(void* lpObj);
int secureblackbox_xmlencryptor_setnamespacecount(void* lpObj, int iNamespaceCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (XMLEncryptor Class)

A user-defined prefix value of a namespace.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_xmlencryptor_getnamespaceprefix(void* lpObj, int namespaceindex);
int secureblackbox_xmlencryptor_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

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

Default Value

""

Remarks

A user-defined prefix value of a namespace.

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

This property is not available at design time.

Data Type

String

NamespaceURI Property (XMLEncryptor Class)

A user-defined URI value of a namespace.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_xmlencryptor_getnamespaceuri(void* lpObj, int namespaceindex);
int secureblackbox_xmlencryptor_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

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

Default Value

""

Remarks

A user-defined URI value of a namespace.

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

This property is not available at design time.

Data Type

String

Config Method (XMLEncryptor 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_xmlencryptor_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 (XMLEncryptor 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_xmlencryptor_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;....

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.

Encrypt Method (XMLEncryptor Class)

Encrypts an XML document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int secureblackbox_xmlencryptor_encrypt(void* lpObj);

int Encrypt();

Remarks

Call this method to encrypt an XML document.

The class could be used to encrypt the SOAP message as well.

Example 1: Encrypting the SOAP message

 
 Copy
void EncryptSOAPMessage(string inputFilename, string outputFilename, string cert, string certPassword)
{
    string encKeyId = "EK-" + Guid.NewGuid().ToString();
    string encDataId = "ED-" + Guid.NewGuid().ToString();

    using (Xmlencryptor encryptor = new Xmlencryptor())
    {
        encryptor.InputFile = inputFilename;
        encryptor.OutputFile = outputFilename;

        string certB64;
        using (Certificatemanager certMgr = new Certificatemanager())
        {
            certMgr.ImportFromFile(cert, certPassword);
            encryptor.KeyEncryptionCertificate = certMgr.Certificate;

            using (Utils utils = new Utils())
            {
                var certBytes = certMgr.Certificate.Bytes;
                certB64 = utils.Base64Encode(certBytes, false);
            }
        }

        encryptor.XMLNode = "/soapv11:Envelope/soapv11:Body";
        encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtContent;
        encryptor.EncryptionMethod = "AES128";
        encryptor.EncryptKey = true;
        encryptor.KeyEncryptionType = XmlencryptorKeyEncryptionTypes.cxetKeyTransport;
        encryptor.KeyTransportMethod = XmlencryptorKeyTransportMethods.cxktRSA15;

        encryptor.Config($"EncryptedDataID={encDataId}");
        encryptor.Config($"EncryptedKeyID={encKeyId}");
        encryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security");
        encryptor.Config("KeyInfoCustomXML=<wsse:SecurityTokenReference xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" " +
          "xmlns:wsse11=\"http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd\" wsse11:TokenType=\"http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey\">" +
          $"<wsse:Reference URI=\"#{encKeyId}\"/>" +
          "</wsse:SecurityTokenReference>");

        encryptor.Config("EncryptedKeyInfoCustomXML=<wsse:SecurityTokenReference xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">" +
          $"<ds:X509Data xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">{certB64}</ds:X509Data>" +
          "</wsse:SecurityTokenReference>");

        encryptor.Encrypt();
    }
}

EncryptSOAPMessage(@"soap_test.xml", @"soap_encrypted.xml", @"cert.pfx", "password");

Sample SOAP message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" soap:mustUnderstand="1">
    </wsse:Security>
  </soap:Header>
  <soap:Body>
    <ns:Data xmlns:ns="http://test.com">Sample message</ns:Data>
  </soap:Body>
</soap:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" soap:mustUnderstand="1">
      <xenc:EncryptedKey Id="EK-89565c75-9556-43d3-9de0-35ce6577e798" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#">
        <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5"/>
        <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
          <wsse:SecurityTokenReference xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <ds:X509Data xmlns:ds="http://www.w3.org/2000/09/xmldsig#">...</ds:X509Data>
          </wsse:SecurityTokenReference>
        </ds:KeyInfo>
        <xenc:CipherData>
          <xenc:CipherValue>...</xenc:CipherValue>
        </xenc:CipherData>
      </xenc:EncryptedKey>
    </wsse:Security>
  </soap:Header>
  <soap:Body>
    <xenc:EncryptedData Id="ED-90fe019e-0093-489d-a646-7ae0cee237c2" Type="http://www.w3.org/2001/04/xmlenc#Content" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
      <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/>
      <ds:KeyInfo>
        <wsse:SecurityTokenReference xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsse11="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd" wsse11:TokenType="http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey">
          <wsse:Reference URI="#EK-89565c75-9556-43d3-9de0-35ce6577e798"/>
        </wsse:SecurityTokenReference>
      </ds:KeyInfo>
      <xenc:CipherData>
        <xenc:CipherValue>...</xenc:CipherValue>
      </xenc:CipherData>
    </xenc:EncryptedData>
  </soap:Body>
</soap:Envelope>

 
 Copy
void DecryptSOAPMessage(string inputFilename, string outputFilename, string cert, string certPassword)
{
    using (Xmldecryptor decryptor = new Xmldecryptor())
    {
        decryptor.InputFile = inputFilename;
        decryptor.OutputFile = outputFilename;

        using (Certificatemanager certMgr = new Certificatemanager())
        {
            certMgr.ImportFromFile(cert, certPassword);
            decryptor.KeyDecryptionCertificate = certMgr.Certificate;
        }

        decryptor.XMLElement = "/soapv11:Envelope/soapv11:Body/xenc:EncryptedData";
        decryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security");

        decryptor.Decrypt();
    }
}

DecryptSOAPMessage(@"soap_encrypted.xml", @"soap_decrypted.xml", @"cert.pfx", "password");

 
 Copy
void SignAndEncryptSOAPMessage(string inputFilename, string outputFilename, string signingCert, string signingCertPassword, string encryptionCert, string encryptionCertPassword)
{
    byte[] data;
    string encKeyId = "EK-" + Guid.NewGuid().ToString();
    string encDataId1 = "ED-" + Guid.NewGuid().ToString();
    string encDataId2 = "ED-" + Guid.NewGuid().ToString();

    // Step 1: Creating Web service security (WSS) signature

    using (Soapsigner signer = new Soapsigner()) 
    {
        signer.InputFile = inputFilename;

        // loading the signing certificate

        using (Certificatemanager certMgr = new Certificatemanager())
        {
            certMgr.ImportFromFile(encryptionCert, encryptionCertPassword);
            signer.SigningCertificate = certMgr.Certificate;
        }

        signer.NewSignature.SignatureType = SOAPSignatureTypes.sstWSSSignature;
        signer.NewSignature.HashAlgorithm = "SHA256";
        signer.NewSignature.XAdES = false;
        signer.SecurityHeaderIndex = 0;

        signer.AddBodyReference("ID-" + Guid.NewGuid().ToString(), false);

        signer.Sign();

        data = signer.OutputBytes;
    }

    using (Xmlencryptor encryptor = new Xmlencryptor())
    {
        // Step 2: loading the encryption certificate

        string certB64;
        using (Certificatemanager certMgr = new Certificatemanager())
        {
            certMgr.ImportFromFile(encryptionCert, encryptionCertPassword);
            encryptor.KeyEncryptionCertificate = certMgr.Certificate;
            
            using (Utils utils = new Utils())
            {
                var certBytes = certMgr.Certificate.Bytes;
                certB64 = utils.Base64Encode(certBytes, false);
            }
        }

        // Step 3: generating random key encryption key (128-bit length)
        // this key will be used for both encryptions

        byte[] KEK;
        using (Rnd rnd = new Rnd())
        {
            KEK = rnd.NextBytes(16);
        }

        encryptor.KeyEncryptionKey = KEK;

        // Step 4: encrypting Body element and placing encrypted key to the Security block in the SOAP Message Header

        encryptor.XMLNode = "/soapv11:Envelope/soapv11:Body";
        encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtContent;
        encryptor.EncryptionMethod = "AES128";
        encryptor.EncryptKey = true;
        encryptor.KeyEncryptionType = XmlencryptorKeyEncryptionTypes.cxetKeyTransport;
        encryptor.KeyTransportMethod = XmlencryptorKeyTransportMethods.cxktRSA15;

        encryptor.Config($"EncryptedDataID={encDataId1}");
        encryptor.Config($"EncryptedKeyID={encKeyId}");
        encryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security");
        encryptor.Config("KeyInfoCustomXML=<wsse:SecurityTokenReference xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" " +
          "xmlns:wsse11=\"http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd\" wsse11:TokenType=\"http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey\">" +
          $"<wsse:Reference URI=\"#{encKeyId}\"/>" +
          "</wsse:SecurityTokenReference>");

        encryptor.Config("EncryptedKeyInfoCustomXML=<wsse:SecurityTokenReference xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">" +
          $"<ds:X509Data xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">{certB64}</ds:X509Data>" +
          "</wsse:SecurityTokenReference>");

        encryptor.InputBytes = data;

        encryptor.Encrypt();

        // Step 5: encrypting WSS Signature

        encryptor.InputBytes = encryptor.OutputBytes;                

        // resetting settings
        encryptor.Config("EncryptedKeyXMLElement=");
        encryptor.Config("EncryptedKeyInfoCustomXML=");

        encryptor.XMLNode = "/soapv11:Envelope/soapv11:Header/wsse:Security/ds:Signature";
        encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtElement;

        encryptor.EncryptKey = false;
        encryptor.Config($"EncryptedDataID={encDataId2}");
        encryptor.Config("KeyInfoCustomXML=<wsse:SecurityTokenReference xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" " +
          "xmlns:wsse11=\"http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd\" wsse11:TokenType=\"http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey\">" +
          $"<wsse:Reference URI=\"#{encKeyId}\"/>" +
          "</wsse:SecurityTokenReference>");

        encryptor.Encrypt();

        data = encryptor.OutputBytes;
    }

    // Step 6: miscellaneous XML DOM manipulations, not supported by XMLEncryptor, but may be required by SOAP standard
    using (Soapsigner signer = new Soapsigner())
    {
        signer.InputBytes = data;
        signer.OutputFile = outputFilename;

        signer.Open();

        // Adding xenc:ReferenceList element to xenc:EncryptedKey element
        signer.SetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey",
            signer.GetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey") +
            "<xenc:ReferenceList>" +
            $"<xenc:DataReference URI=\"#{encDataId1}\"/>" +
            $"<xenc:DataReference URI=\"#{encDataId2}\"/>" +
            "</xenc:ReferenceList>");

        // swapping the order of elements in WSS Security header
        // SOAP requires that items in the header are placed in the order that they will be processed, not the order they were generated
        // because the decryption should be performed before veryfing SOAP message, the xenc:EncryptedKey element should be placed first
        var encKeyContent = signer.GetOuterXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey");
        var secContent = signer.GetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security");
        var k = secContent.IndexOf(encKeyContent, StringComparison.Ordinal);
        if (k != -1)
            signer.SetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security", encKeyContent + secContent.Substring(0, k));

        signer.Close(true);
    }
}

SignAndEncryptSOAPMessage(@"soap_test.xml", @"soap_signed_encrypted.xml", @"cert.pfx", "password", @"cert2.pfx", "password2");

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns:Data xmlns:ns="http://test.com">Sample message</ns:Data>
  </soap:Body>
</soap:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" soap:mustUnderstand="1">
      <xenc:EncryptedKey Id="EK-14e69f03-fc61-48f1-b825-b03ca613f0f8" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#">
        <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"/>
        <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
          <wsse:SecurityTokenReference xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <ds:X509Data xmlns:ds="http://www.w3.org/2000/09/xmldsig#">...</ds:X509Data>
          </wsse:SecurityTokenReference>
        </ds:KeyInfo>
        <xenc:CipherData xmlns:xenc="http://www.w3.org/2001/04/xmlenc#">
          <xenc:CipherValue>...</xenc:CipherValue>
        </xenc:CipherData>
        <xenc:ReferenceList>
          <xenc:DataReference URI="#ED-65385224-0bb5-43f0-b4bf-67a9e9452c10"/>
          <xenc:DataReference URI="#ED-4267b8f3-8662-4441-99ec-32a2e9180288"/>
        </xenc:ReferenceList>
      </xenc:EncryptedKey>
      <wsse:BinarySecurityToken ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary" wsu:Id="id-1135467976" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">...</wsse:BinarySecurityToken>
      <xenc:EncryptedData Id="ED-4267b8f3-8662-4441-99ec-32a2e9180288" Type="http://www.w3.org/2001/04/xmlenc#Element" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/>
        <ds:KeyInfo>
          <wsse:SecurityTokenReference xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsse11="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd" wsse11:TokenType="http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey">
            <wsse:Reference URI="#EK-14e69f03-fc61-48f1-b825-b03ca613f0f8"/>
          </wsse:SecurityTokenReference>
        </ds:KeyInfo>
        <xenc:CipherData>
          <xenc:CipherValue>...</xenc:CipherValue>
        </xenc:CipherData>
      </xenc:EncryptedData>
    </wsse:Security>
  </soap:Header>
  <soap:Body wsu:Id="ID-5bbf3495-d919-416e-96c3-67759aab9cf8" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <xenc:EncryptedData Id="ED-65385224-0bb5-43f0-b4bf-67a9e9452c10" Type="http://www.w3.org/2001/04/xmlenc#Content" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
      <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/>
      <ds:KeyInfo>
        <wsse:SecurityTokenReference xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsse11="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd" wsse11:TokenType="http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey">
          <wsse:Reference URI="#EK-14e69f03-fc61-48f1-b825-b03ca613f0f8"/>
        </wsse:SecurityTokenReference>
      </ds:KeyInfo>
      <xenc:CipherData>
        <xenc:CipherValue>...</xenc:CipherValue>
      </xenc:CipherData>
    </xenc:EncryptedData>
  </soap:Body>
</soap:Envelope>

 
 Copy
void DecryptAndVerifySOAPMessage(string inputFilename, string outputFilename, string decryptionCert, string decryptionCertPassword)
{
    byte[] data;
    using (Xmldecryptor decryptor = new Xmldecryptor())
    {
        decryptor.InputFile = inputFilename;
        decryptor.OutputFile = outputFilename;

        using (Certificatemanager certMgr = new Certificatemanager())
        {
            certMgr.ImportFromFile(decryptionCert, decryptionCertPassword);
            decryptor.KeyDecryptionCertificate = certMgr.Certificate;
        }

        decryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security");

        decryptor.Decrypt();
    }

    using (Soapverifier verifier =  new Soapverifier())
    {
        verifier.InputFile = outputFilename;

        verifier.Verify();

        if ((verifier.Signatures.Count != 1) || (verifier.Signatures[0].SignatureValidationResult != XMLSignatureValidities.xsvValid))
            throw new Exception("Signature not found or failed to verify a signature");
    }
}

DecryptAndVerifySOAPMessage(@"soap_signed_encrypted.xml", @"soap_signed_decrypted.xml", @"cert2.pfx", "password2");

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

Information about errors during signing.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPTOR_ERROR 1

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

class XMLEncryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass XMLEncryptor and override this emitter function.
virtual int FireError(XMLEncryptorErrorEventParams *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.

FormatElement Event (XMLEncryptor Class)

Reports the XML element that is currently being processed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPTOR_FORMATELEMENT 2

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

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

// Or, subclass XMLEncryptor and override this emitter function.
virtual int FireFormatElement(XMLEncryptorFormatElementEventParams *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 (XMLEncryptor Class)

Reports XML text that is currently being processed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPTOR_FORMATTEXT 3

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

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

// Or, subclass XMLEncryptor and override this emitter function.
virtual int FireFormatText(XMLEncryptorFormatTextEventParams *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 (XMLEncryptor Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_XMLENCRYPTOR_NOTIFICATION 4

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

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

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

Config Settings (XMLEncryptor Class)

XMLEncryptor Config Settings

Base Config Settings

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

XMLEncryptor Errors