XMLEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The XMLEncryptor class encrypts XML documents.

Class Name

SecureBlackbox_XMLEncryptor

Procedural Interface

 secureblackbox_xmlencryptor_open();
 secureblackbox_xmlencryptor_close($res);
 secureblackbox_xmlencryptor_register_callback($res, $id, $function);
 secureblackbox_xmlencryptor_get_last_error($res);
 secureblackbox_xmlencryptor_get_last_error_code($res);
 secureblackbox_xmlencryptor_set($res, $id, $index, $value);
 secureblackbox_xmlencryptor_get($res, $id, $index);
 secureblackbox_xmlencryptor_do_config($res, $configurationstring);
 secureblackbox_xmlencryptor_do_doaction($res, $actionid, $actionparams);
 secureblackbox_xmlencryptor_do_encrypt($res);

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

Specifies XML encoding.

Object Oriented Interface

public function getEncoding();


public function setEncoding($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 1 );


secureblackbox_xmlencryptor_set($res, 1, $value );

Default Value

''

Remarks

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

Data Type

String

EncryptedDataType Property (SecureBlackbox_XMLEncryptor Class)

Specifies the type of the data being encrypted.

Object Oriented Interface

public function getEncryptedDataType();


public function setEncryptedDataType($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 2 );


secureblackbox_xmlencryptor_set($res, 2, $value );

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.

Data Type

Integer

EncryptionKey Property (SecureBlackbox_XMLEncryptor Class)

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

Object Oriented Interface

public function getEncryptionKey();


public function setEncryptionKey($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 3 );


secureblackbox_xmlencryptor_set($res, 3, $value );

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

The encryption method used to encrypt the document.

Object Oriented Interface

public function getEncryptionMethod();


public function setEncryptionMethod($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 4 );


secureblackbox_xmlencryptor_set($res, 4, $value );

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

Specifies if the encryption key is encrypted.

Object Oriented Interface

public function getEncryptKey();


public function setEncryptKey($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 5 );


secureblackbox_xmlencryptor_set($res, 5, $value );

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

The data that should be encrypted.

Object Oriented Interface

public function getExternalData();


public function setExternalData($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 6 );


secureblackbox_xmlencryptor_set($res, 6, $value );

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

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 7 );


secureblackbox_xmlencryptor_set($res, 7, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_XMLEncryptor Class)

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

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 8 );


secureblackbox_xmlencryptor_set($res, 8, $value );

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

The XML document to be encrypted.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 9 );


secureblackbox_xmlencryptor_set($res, 9, $value );

Default Value

''

Remarks

Provide the path to the XML document to be encrypted.

Data Type

String

KeyEncryptionCertBytes Property (SecureBlackbox_XMLEncryptor Class)

Returns raw certificate data in DER format.

Object Oriented Interface

public function getKeyEncryptionCertBytes();

Procedural Interface

secureblackbox_xmlencryptor_get($res, 10 );

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

KeyEncryptionCertHandle Property (SecureBlackbox_XMLEncryptor Class)

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

Object Oriented Interface

public function getKeyEncryptionCertHandle();


public function setKeyEncryptionCertHandle($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 17 );


secureblackbox_xmlencryptor_set($res, 17, $value );

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

KeyEncryptionKey Property (SecureBlackbox_XMLEncryptor Class)

The symmetric key used to encrypt a session key.

Object Oriented Interface

public function getKeyEncryptionKey();


public function setKeyEncryptionKey($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 44 );


secureblackbox_xmlencryptor_set($res, 44, $value );

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

Specifies how the session key is encrypted.

Object Oriented Interface

public function getKeyEncryptionType();


public function setKeyEncryptionType($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 45 );


secureblackbox_xmlencryptor_set($res, 45, $value );

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyTransportMethod Property (SecureBlackbox_XMLEncryptor Class)

Specifies how the session key is encrypted.

Object Oriented Interface

public function getKeyTransportMethod();


public function setKeyTransportMethod($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 46 );


secureblackbox_xmlencryptor_set($res, 46, $value );

Default Value

0

Remarks

This property specifies how the session key is encrypted.

Supported values:

Data Type

Integer

KeyWrapMethod Property (SecureBlackbox_XMLEncryptor Class)

The key wrap method used to encrypt the session key.

Object Oriented Interface

public function getKeyWrapMethod();


public function setKeyWrapMethod($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 47 );


secureblackbox_xmlencryptor_set($res, 47, $value );

Default Value

'Camellia256'

Remarks

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

Supported values:

Data Type

String

OutputBytes Property (SecureBlackbox_XMLEncryptor Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_xmlencryptor_get($res, 48 );

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if 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 (SecureBlackbox_XMLEncryptor Class)

Defines where to save the encrypted XML document.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 49 );


secureblackbox_xmlencryptor_set($res, 49, $value );

Default Value

''

Remarks

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

Data Type

String

UseGCM Property (SecureBlackbox_XMLEncryptor Class)

Specifies if GCM mode is enabled.

Object Oriented Interface

public function getUseGCM();


public function setUseGCM($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 50 );


secureblackbox_xmlencryptor_set($res, 50, $value );

Default Value

false

Remarks

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

Data Type

Boolean

XMLNode Property (SecureBlackbox_XMLEncryptor Class)

Defines the XML element to encrypt.

Object Oriented Interface

public function getXMLNode();


public function setXMLNode($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 51 );


secureblackbox_xmlencryptor_set($res, 51, $value );

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

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();


public function setNamespaceCount($value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 52 );


secureblackbox_xmlencryptor_set($res, 52, $value );

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

A user-defined prefix value of a namespace.

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);


public function setNamespacePrefix($namespaceindex, $value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 53 , $namespaceindex);


secureblackbox_xmlencryptor_set($res, 53, $value , $namespaceindex);

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

A user-defined URI value of a namespace.

Object Oriented Interface

public function getNamespaceURI($namespaceindex);


public function setNamespaceURI($namespaceindex, $value);

Procedural Interface

secureblackbox_xmlencryptor_get($res, 54 , $namespaceindex);


secureblackbox_xmlencryptor_set($res, 54, $value , $namespaceindex);

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_xmlencryptor_do_config($res, $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 (SecureBlackbox_XMLEncryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_xmlencryptor_do_doaction($res, $actionid, $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 insencitive) 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 (SecureBlackbox_XMLEncryptor Class)

Encrypts an XML document.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

secureblackbox_xmlencryptor_do_encrypt($res);

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

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

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

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

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

Information about errors during signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_xmlencryptor_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 '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 (SecureBlackbox_XMLEncryptor Class)

Reports the XML element that is currently being processed.

Object Oriented Interface

public function fireFormatElement($param);

Procedural Interface

secureblackbox_xmlencryptor_register_callback($res, 2, array($this, 'fireFormatElement'));

Parameter List

 'starttagwhitespace'
 'endtagwhitespace'
 'level'
 'path'
 '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 (SecureBlackbox_XMLEncryptor Class)

Reports XML text that is currently being processed.

Object Oriented Interface

public function fireFormatText($param);

Procedural Interface

secureblackbox_xmlencryptor_register_callback($res, 3, array($this, 'fireFormatText'));

Parameter List

 'text'
 'texttype'
 'level'
 '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 (SecureBlackbox_XMLEncryptor Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_xmlencryptor_register_callback($res, 4, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class 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 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 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)