XMLEncryptor Class
Properties Methods Events Config Settings Errors
The XMLEncryptor class encrypts XML documents.
Syntax
class 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.
| encoding | Specifies XML encoding. |
| encrypted_data_type | Specifies the type of the data being encrypted. |
| encryption_key | The symmetric (session) key used to encrypt the data. |
| encryption_method | The encryption method used to encrypt the document. |
| encrypt_key | Specifies if the encryption key is encrypted. |
| external_data | The data that should be encrypted. |
| fips_mode | Reserved. |
| input_bytes | Use this property to pass the input to class in byte array form. |
| input_file | The XML document to be encrypted. |
| key_encryption_cert_bytes | Returns the raw certificate data in DER format. |
| key_encryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| key_encryption_key | The symmetric key used to encrypt a session key. |
| key_encryption_type | Specifies how the session key is encrypted. |
| key_transport_method | Specifies how the session key is encrypted. |
| key_wrap_method | The key wrap method used to encrypt the session key. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | Defines where to save the encrypted XML document. |
| use_gcm | Specifies if GCM mode is enabled. |
| xml_node | Defines the XML element to encrypt. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_known_namespace | Adds known prefix and correspondent namespace URI. |
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| encrypt | Encrypts an XML document. |
| reset | Resets the class settings. |
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.
| on_error | Information about errors during signing. |
| on_format_element | Reports the XML element that is currently being processed. |
| on_format_text | Reports XML text that is currently being processed. |
| on_notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| EncryptedDataID | Specifies the ID for EncryptedData element. |
| EncryptedKeyID | Specifies the ID for EncryptedKey element. |
| EncryptedKeyInfoCustomXML | The custom XML content for EncryptedKey\\KeyInfo element. |
| EncryptedKeyInfoID | Specifies the ID for EncryptedKey\\KeyInfo element. |
| EncryptedKeyOnly | Specifies whether to create only EncryptedKey element. |
| EncryptedKeyXMLElement | Specifies the XML element where to save the encrypted key element. |
| EncryptionPrefix | Specifies the encryption prefix. |
| KeyInfoCustomXML | The custom XML content for KeyInfo element. |
| KeyInfoID | Specifies the ID for KeyInfo element. |
| KeyName | Contains information about the key used for encryption. |
| MimeType | Specifies the mime type of the encrypted data. |
| SignaturePrefix | Specifies the signature prefix. |
| TempPath | Path for storing temporary files. |
| WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
| XMLFormatting | Specifies the signature XML formatting. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
encoding Property
Specifies XML encoding.
Syntax
def get_encoding() -> str: ... def set_encoding(value: str) -> None: ...
encoding = property(get_encoding, set_encoding)
Default Value
""
Remarks
Use this property to specify the encoding to apply to the XML documents.
encrypted_data_type Property
Specifies the type of the data being encrypted.
Syntax
def get_encrypted_data_type() -> int: ... def set_encrypted_data_type(value: int) -> None: ...
encrypted_data_type = property(get_encrypted_data_type, set_encrypted_data_type)
Default Value
0
Remarks
This property specifies the data type to be encrypted.
Supported values:
| cxedtElement | 0 | The XML element is encrypted.
xml_node property specifies the XML element that should be encrypted. |
| cxedtContent | 1 | Element content is encrypted.
xml_node property specifies the XML element which content should be encrypted. |
| cxedtExternal | 2 | External data is encrypted. Use external_data property to set the data that should be encrypted.
xml_node property specifies the location where xenc:EncryptedData element should be placed. |
encryption_key Property
The symmetric (session) key used to encrypt the data.
Syntax
def get_encryption_key() -> bytes: ... def set_encryption_key(value: bytes) -> None: ...
encryption_key = property(get_encryption_key, set_encryption_key)
Remarks
Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data.
It is required when the encrypt_key property is disabled. If the encrypt_key property is enabled, and no value is set, the component will generate a random session key (recommended).
encryption_method Property
The encryption method used to encrypt the document.
Syntax
def get_encryption_method() -> str: ... def set_encryption_method(value: str) -> None: ...
encryption_method = property(get_encryption_method, set_encryption_method)
Default Value
"AES256"
Remarks
This property contains the encryption algorithm used to encrypt the XML document.
Supported values:
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
If use_gcm property is enabled, then supported values are:
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 |
encrypt_key Property
Specifies if the encryption key is encrypted.
Syntax
def get_encrypt_key() -> bool: ... def set_encrypt_key(value: bool) -> None: ...
encrypt_key = property(get_encrypt_key, set_encrypt_key)
Default Value
FALSE
Remarks
Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data.
external_data Property
The data that should be encrypted.
Syntax
def get_external_data() -> bytes: ... def set_external_data(value: bytes) -> None: ...
external_data = property(get_external_data, set_external_data)
Remarks
Use this property to provide the data that should be encrypted if encrypted_data_type property is set to cxedtExternal value.
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
input_bytes Property
Use this property to pass the input to class in byte array form.
Syntax
def get_input_bytes() -> bytes: ... def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
Remarks
Assign a byte array containing the data to be processed to this property.
input_file Property
The XML document to be encrypted.
Syntax
def get_input_file() -> str: ... def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
Default Value
""
Remarks
Provide the path to the XML document to be encrypted.
key_encryption_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_key_encryption_cert_bytes() -> bytes: ...
key_encryption_cert_bytes = property(get_key_encryption_cert_bytes, None)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
key_encryption_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_key_encryption_cert_handle() -> int: ... def set_key_encryption_cert_handle(value: int) -> None: ...
key_encryption_cert_handle = property(get_key_encryption_cert_handle, set_key_encryption_cert_handle)
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());
key_encryption_key Property
The symmetric key used to encrypt a session key.
Syntax
def get_key_encryption_key() -> bytes: ... def set_key_encryption_key(value: bytes) -> None: ...
key_encryption_key = property(get_key_encryption_key, set_key_encryption_key)
Remarks
Use this property to provide the encryption symmetric key that will be used to encrypt a session key. It is required when the encrypt_key property is enabled and key_encryption_type is set to cxetKeyWrap value.
key_encryption_type Property
Specifies how the session key is encrypted.
Syntax
def get_key_encryption_type() -> int: ... def set_key_encryption_type(value: int) -> None: ...
key_encryption_type = property(get_key_encryption_type, set_key_encryption_type)
Default Value
0
Remarks
This property specifies how the session key is encrypted.
Supported values:
| cxetKeyTransport | 0 | The key is encrypted using public-key based algorithm |
| cxetKeyWrap | 1 | The key is encrypted using symmetric algorithm with pre-shared secret key |
key_transport_method Property
Specifies how the session key is encrypted.
Syntax
def get_key_transport_method() -> int: ... def set_key_transport_method(value: int) -> None: ...
key_transport_method = property(get_key_transport_method, set_key_transport_method)
Default Value
0
Remarks
This property specifies how the session key is encrypted.
Supported values:
| cxktRSA15 | 0 | RSA 1.5 (RSAES-PKCS1-v1_5) encryption is used |
| cxktRSAOAEP | 1 | RSA-OAEP (RSAES-OAEP-ENCRYPT) encryption is used |
key_wrap_method Property
The key wrap method used to encrypt the session key.
Syntax
def get_key_wrap_method() -> str: ... def set_key_wrap_method(value: str) -> None: ...
key_wrap_method = property(get_key_wrap_method, set_key_wrap_method)
Default Value
"Camellia256"
Remarks
This property specifies the key wrap algorithm used to encrypt the session key.
Supported values:
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
output_bytes Property
Use this property to read the output the class object has produced.
Syntax
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
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 output_file and output_stream properties had not been assigned.
This property is read-only.
output_file Property
Defines where to save the encrypted XML document.
Syntax
def get_output_file() -> str: ... def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
Default Value
""
Remarks
Specifies the path where the encrypted XML document should be saved.
use_gcm Property
Specifies if GCM mode is enabled.
Syntax
def get_use_gcm() -> bool: ... def set_use_gcm(value: bool) -> None: ...
use_gcm = property(get_use_gcm, set_use_gcm)
Default Value
FALSE
Remarks
Use this property to enable Galois/Counter Mode (GCM) mode for AES encryption method.
xml_node Property
Defines the XML element to encrypt.
Syntax
def get_xml_node() -> str: ... def set_xml_node(value: str) -> None: ...
xml_node = property(get_xml_node, set_xml_node)
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:
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use add_known_namespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via add_known_namespace method. |
| Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
add_known_namespace Method
Adds known prefix and correspondent namespace URI.
Syntax
def add_known_namespace(prefix: str, uri: str) -> None: ...
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
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action 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
Encrypts an XML document.
Syntax
def encrypt() -> None: ...
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 != 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
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
on_error Event
Information about errors during signing.
Syntax
class XMLEncryptorErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class XMLEncryptor: @property def on_error() -> Callable[[XMLEncryptorErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[XMLEncryptorErrorEventParams], None]) -> None: ...
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.
on_format_element Event
Reports the XML element that is currently being processed.
Syntax
class XMLEncryptorFormatElementEventParams(object): @property def start_tag_whitespace() -> str: ... @start_tag_whitespace.setter def start_tag_whitespace(value) -> None: ... @property def end_tag_whitespace() -> str: ... @end_tag_whitespace.setter def end_tag_whitespace(value) -> None: ... @property def level() -> int: ... @property def path() -> str: ... @property def has_child_elements() -> bool: ... # In class XMLEncryptor: @property def on_format_element() -> Callable[[XMLEncryptorFormatElementEventParams], None]: ... @on_format_element.setter def on_format_element(event_hook: Callable[[XMLEncryptorFormatElementEventParams], None]) -> None: ...
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.
on_format_text Event
Reports XML text that is currently being processed.
Syntax
class XMLEncryptorFormatTextEventParams(object): @property def text() -> str: ... @text.setter def text(value) -> None: ... @property def text_type() -> int: ... @property def level() -> int: ... @property def path() -> str: ... # In class XMLEncryptor: @property def on_format_text() -> Callable[[XMLEncryptorFormatTextEventParams], None]: ... @on_format_text.setter def on_format_text(event_hook: Callable[[XMLEncryptorFormatTextEventParams], None]) -> None: ...
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.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class XMLEncryptorNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class XMLEncryptor: @property def on_notification() -> Callable[[XMLEncryptorNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[XMLEncryptorNotificationEventParams], None]) -> None: ...
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.
XMLEncryptor Config Settings
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
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"
Supported values are:
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use add_known_namespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via add_known_namespace method. |
| Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
Default value is "xenc". In this case "xenc:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"
Default value is "ds". In this case "ds:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Supported values:
| "" or "none" | no formatting (by default). | |
| "auto" | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" |
| indent | specifies indentation level (default is 1) | |
| indent-char | specifies indentation character: "space" or "tab" (default) | |
| base64-max-length | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) | |
| starting-level | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). | |
| indent-before-main | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" |
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
XMLEncryptor Errors
XMLEncryptor Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 39845889 | The input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS) |
| 39845890 | Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS) |
| 39845892 | Unsupported hash algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM) |
| 39845893 | Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE) |
| 39845895 | Unsupported encryption algorithm (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD) |
| 39845896 | XML element not found (SB_ERROR_XML_NOT_FOUND) |
| 39845897 | XML element has no ID (SB_ERROR_XML_NO_ELEMENT_ID) |