XMLEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The XMLEncryptor class encrypts XML documents.

Syntax

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

public String getEncoding();


public void setEncoding(String encoding);

Default Value

""

Remarks

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

EncryptedDataType Property (XMLEncryptor Class)

Specifies the type of the data being encrypted.

Syntax

public int getEncryptedDataType();


public void setEncryptedDataType(int encryptedDataType);


Enumerated values:
  public final static int cxedtElement = 0;
  public final static int cxedtContent = 1;
  public final static int cxedtExternal = 2;

Default Value

0

Remarks

This property specifies the data type to be encrypted.

Supported values:

If the XMLNode property is set to the empty string, and the InputStream and InputFile properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element.

EncryptionKey Property (XMLEncryptor Class)

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

Syntax

public byte[] getEncryptionKey();


public void setEncryptionKey(byte[] encryptionKey);

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.

EncryptionMethod Property (XMLEncryptor Class)

The encryption method used to encrypt the document.

Syntax

public String getEncryptionMethod();


public void setEncryptionMethod(String encryptionMethod);

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:

EncryptKey Property (XMLEncryptor Class)

Specifies if the encryption key is encrypted.

Syntax

public boolean isEncryptKey();


public void setEncryptKey(boolean encryptKey);

Default Value

False

Remarks

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

ExternalData Property (XMLEncryptor Class)

The data that should be encrypted.

Syntax

public byte[] getExternalData();


public void setExternalData(byte[] externalData);

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.

FIPSMode Property (XMLEncryptor Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

InputBytes Property (XMLEncryptor Class)

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

Syntax

public byte[] getInputBytes();


public void setInputBytes(byte[] inputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (XMLEncryptor Class)

The XML document to be encrypted.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

Provide the path to the XML document to be encrypted.

InputStream Property (XMLEncryptor Class)

Stream containing the XML document.

Syntax

public java.io.InputStream getInputStream();


public void setInputStream(java.io.InputStream inputStream);

Default Value

null

Remarks

Use this property to feed the XML document to the class via a stream.

This property is not available at design time.

KeyEncryptionCertificate Property (XMLEncryptor Class)

The certificate used to encrypt a session key.

Syntax

public Certificate getKeyEncryptionCertificate();


public void setKeyEncryptionCertificate(Certificate keyEncryptionCertificate);

Remarks

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

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

KeyEncryptionKey Property (XMLEncryptor Class)

The symmetric key used to encrypt a session key.

Syntax

public byte[] getKeyEncryptionKey();


public void setKeyEncryptionKey(byte[] keyEncryptionKey);

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.

KeyEncryptionType Property (XMLEncryptor Class)

Specifies how the session key is encrypted.

Syntax

public int getKeyEncryptionType();


public void setKeyEncryptionType(int keyEncryptionType);


Enumerated values:
  public final static int cxetKeyTransport = 0;
  public final static int cxetKeyWrap = 1;

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

KeyTransportMethod Property (XMLEncryptor Class)

Specifies how the session key is encrypted.

Syntax

public int getKeyTransportMethod();


public void setKeyTransportMethod(int keyTransportMethod);


Enumerated values:
  public final static int cxktRSA15 = 0;
  public final static int cxktRSAOAEP = 1;

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

KeyWrapMethod Property (XMLEncryptor Class)

The key wrap method used to encrypt the session key.

Syntax

public String getKeyWrapMethod();


public void setKeyWrapMethod(String keyWrapMethod);

Default Value

"Camellia256"

Remarks

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

Supported values:

OutputBytes Property (XMLEncryptor Class)

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

Syntax

public byte[] 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.

OutputFile Property (XMLEncryptor Class)

Defines where to save the encrypted XML document.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

""

Remarks

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

OutputStream Property (XMLEncryptor Class)

A stream where the encrypted XML document can be written to.

Syntax

public java.io.OutputStream getOutputStream();


public void setOutputStream(java.io.OutputStream outputStream);

Default Value

null

Remarks

Use this property to save the encrypted XML document to the stream.

This property is not available at design time.

UseGCM Property (XMLEncryptor Class)

Specifies if GCM mode is enabled.

Syntax

public boolean isUseGCM();


public void setUseGCM(boolean useGCM);

Default Value

False

Remarks

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

XMLNode Property (XMLEncryptor Class)

Defines the XML element to encrypt.

Syntax

public String getXMLNode();


public void setXMLNode(String XMLNode);

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:

XPathNamespaces Property (XMLEncryptor Class)

Specifies namespaces for XPath expression.

Syntax

public XMLNamespaceList getXPathNamespaces();


public void setXPathNamespaces(XMLNamespaceList XPathNamespaces);

Remarks

This property contains a list of prefixes and namespaceURIs that used in XPath expression with XMLNode property.

Please refer to the XMLNamespace type for a complete list of fields.

Config Method (Xmlencryptor Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DoAction Method (Xmlencryptor Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

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

Encrypt Method (Xmlencryptor Class)

Encrypts an XML document.

Syntax

public void 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");

Note: The above code expects that the SOAP message has a WS Security header element.

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>

Sample encrypted SOAP message produced by the above code:

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

Example 2: Decrypting the SOAP message

 
 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");

Example 3: Signing and encrypting the SOAP message

 
 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");

Sample SOAP message:

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

Sample signed and encrypted SOAP message produced by the above code:

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

Example 4: Decrypting and verifying the SOAP message

 
 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 Event (Xmlencryptor Class)

Information about errors during signing.

Syntax

public class DefaultXmlencryptorEventListener implements XmlencryptorEventListener {
  ...
  public void error(XmlencryptorErrorEvent e) {}
  ...
}

public class XmlencryptorErrorEvent {
  public int errorCode;
  public String description;
}

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

public class DefaultXmlencryptorEventListener implements XmlencryptorEventListener {
  ...
  public void formatElement(XmlencryptorFormatElementEvent e) {}
  ...
}

public class XmlencryptorFormatElementEvent {
  public String startTagWhitespace;
  public String endTagWhitespace;
  public int level;
  public String path;
  public boolean hasChildElements;
}

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

public class DefaultXmlencryptorEventListener implements XmlencryptorEventListener {
  ...
  public void formatText(XmlencryptorFormatTextEvent e) {}
  ...
}

public class XmlencryptorFormatTextEvent {
  public String text;
  public int textType;
  public int level;
  public String path;
}

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

public class DefaultXmlencryptorEventListener implements XmlencryptorEventListener {
  ...
  public void notification(XmlencryptorNotificationEvent e) {}
  ...
}

public class XmlencryptorNotificationEvent {
  public String eventID;
  public String eventParam;
}

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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

XMLNamespace Type

Represents an XML namespace map for XPath expressions.

Remarks

This class defines the correspondence between Prefixes and namespace URIs.

Fields

Constructors

public XMLNamespace();

Creates a new XML namespace object.

Config Settings (Xmlencryptor Class)

The class accepts one or more of the following configuration settings. Configuration 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.

XMLEncryptor Config Settings

Base Config Settings

Trappable Errors (Xmlencryptor Class)

XMLEncryptor Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	39845889   Input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS)
	39845890   Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS)
	39845891   Unsupported signature method type (SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE)
	39845892   Unsupported has algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM)
	39845893   Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE)
	39845894   Invalid key type (SB_ERROR_XML_INVALID_KEY_TYPE)
	39845895   Invalid encryption method (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD)
	39845896   Not found (SB_ERROR_XML_NOT_FOUND)
	39845897   No element ID (SB_ERROR_XML_NO_ELEMENT_ID)