XMLEncryptor Component

Properties   Methods   Events   Config Settings   Errors  

The XMLEncryptor component encrypts XML documents.

Syntax

TsbxXMLEncryptor

Remarks

XMLEncryptor encrypts XML documents with certificates or generic keys.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Encoding Property (XMLEncryptor Component)

Specifies XML encoding.

Syntax

__property String Encoding = { read=FEncoding, write=FSetEncoding };

Default Value

""

Remarks

Use this property to specify the encoding to apply to the XML documents.

Data Type

String

EncryptedDataType Property (XMLEncryptor Component)

Specifies the type of the data being encrypted.

Syntax

__property TsbxXMLEncryptorEncryptedDataTypes EncryptedDataType = { read=FEncryptedDataType, write=FSetEncryptedDataType };

enum TsbxXMLEncryptorEncryptedDataTypes {
  cxedtElement=0,
  cxedtContent=1,
  cxedtExternal=2
};

Default Value

cxedtElement

Remarks

This property specifies the data type to be encrypted.

Supported values:

Data Type

Integer

EncryptionKey Property (XMLEncryptor Component)

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

Syntax

__property DynamicArray EncryptionKey = { read=FEncryptionKey, write=FSetEncryptionKey };

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

The encryption method used to encrypt the document.

Syntax

__property String EncryptionMethod = { read=FEncryptionMethod, write=FSetEncryptionMethod };

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

Specifies if the encryption key is encrypted.

Syntax

__property bool EncryptKey = { read=FEncryptKey, write=FSetEncryptKey };

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

The data that should be encrypted.

Syntax

__property DynamicArray ExternalData = { read=FExternalData, write=FSetExternalData };

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

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (XMLEncryptor Component)

Use this property to pass the input to component in byte array form.

Syntax

__property DynamicArray InputBytes = { read=FInputBytes, write=FSetInputBytes };

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

The XML document to be encrypted.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

Provide the path to the XML document to be encrypted.

Data Type

String

KeyEncryptionCertBytes Property (XMLEncryptor Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KeyEncryptionCertBytes = { read=FKeyEncryptionCertBytes };

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

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

Syntax

__property __int64 KeyEncryptionCertHandle = { read=FKeyEncryptionCertHandle, write=FSetKeyEncryptionCertHandle };

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

The symmetric key used to encrypt a session key.

Syntax

__property DynamicArray KeyEncryptionKey = { read=FKeyEncryptionKey, write=FSetKeyEncryptionKey };

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

Specifies how the session key is encrypted.

Syntax

__property TsbxXMLEncryptorKeyEncryptionTypes KeyEncryptionType = { read=FKeyEncryptionType, write=FSetKeyEncryptionType };

enum TsbxXMLEncryptorKeyEncryptionTypes {
  cxetKeyTransport=0,
  cxetKeyWrap=1
};

Default Value

cxetKeyTransport

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyTransportMethod Property (XMLEncryptor Component)

Specifies how the session key is encrypted.

Syntax

__property TsbxXMLEncryptorKeyTransportMethods KeyTransportMethod = { read=FKeyTransportMethod, write=FSetKeyTransportMethod };

enum TsbxXMLEncryptorKeyTransportMethods {
  cxktRSA15=0,
  cxktRSAOAEP=1
};

Default Value

cxktRSA15

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyWrapMethod Property (XMLEncryptor Component)

The key wrap method used to encrypt the session key.

Syntax

__property String KeyWrapMethod = { read=FKeyWrapMethod, write=FSetKeyWrapMethod };

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

Use this property to read the output the component object has produced.

Syntax

__property DynamicArray OutputBytes = { read=FOutputBytes };

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

Defines where to save the encrypted XML document.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

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

Data Type

String

UseGCM Property (XMLEncryptor Component)

Specifies if GCM mode is enabled.

Syntax

__property bool UseGCM = { read=FUseGCM, write=FSetUseGCM };

Default Value

false

Remarks

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

Data Type

Boolean

XMLNode Property (XMLEncryptor Component)

Defines the XML element to encrypt.

Syntax

__property String XMLNode = { read=FXMLNode, write=FSetXMLNode };

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

AddKnownNamespace Method (XMLEncryptor Component)

Adds known prefix and correspondent namespace URI.

Syntax

void __fastcall AddKnownNamespace(String Prefix, String URI);

Remarks

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

Config Method (XMLEncryptor Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoAction Method (XMLEncryptor Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

Encrypt Method (XMLEncryptor Component)

Encrypts an XML document.

Syntax

void __fastcall Encrypt();

Remarks

Call this method to encrypt an XML document.

The component 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 != SignatureValidities.svtValid))
            throw new Exception("Signature not found or failed to verify a signature");
    }
}

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

Reset Method (XMLEncryptor Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Error Event (XMLEncryptor Component)

Information about errors during signing.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxXMLEncryptorErrorEventParams;
typedef void __fastcall (__closure *TsbxXMLEncryptorErrorEvent)(System::TObject* Sender, TsbxXMLEncryptorErrorEventParams *e);
__property TsbxXMLEncryptorErrorEvent OnError = { read=FOnError, write=FOnError };

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

Reports the XML element that is currently being processed.

Syntax

typedef struct {
  String StartTagWhitespace;
  String EndTagWhitespace;
  int Level;
  String Path;
  bool HasChildElements;
} TsbxXMLEncryptorFormatElementEventParams;
typedef void __fastcall (__closure *TsbxXMLEncryptorFormatElementEvent)(System::TObject* Sender, TsbxXMLEncryptorFormatElementEventParams *e);
__property TsbxXMLEncryptorFormatElementEvent OnFormatElement = { read=FOnFormatElement, write=FOnFormatElement };

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

Reports XML text that is currently being processed.

Syntax

typedef struct {
  String Text;
  int TextType;
  int Level;
  String Path;
} TsbxXMLEncryptorFormatTextEventParams;
typedef void __fastcall (__closure *TsbxXMLEncryptorFormatTextEvent)(System::TObject* Sender, TsbxXMLEncryptorFormatTextEventParams *e);
__property TsbxXMLEncryptorFormatTextEvent OnFormatText = { read=FOnFormatText, write=FOnFormatText };

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

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxXMLEncryptorNotificationEventParams;
typedef void __fastcall (__closure *TsbxXMLEncryptorNotificationEvent)(System::TObject* Sender, TsbxXMLEncryptorNotificationEventParams *e);
__property TsbxXMLEncryptorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (XMLEncryptor Component)

XMLEncryptor Config Settings

Base Config Settings

 
 Copy
PKICache=certificate,crl,ocsp

 
 Copy
PKICachePath=C:\Temp\cache

 
 Copy
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

 
 Copy
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

 
 Copy
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

Trappable Errors (XMLEncryptor Component)

XMLEncryptor Errors