XMLEncrypt Class
Properties Methods Events Config Settings Errors
The XMLEncrypt class is used to encrypt and decrypt XML.
Syntax
class ipworksencrypt.XMLEncrypt
Remarks
The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The encrypt method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting the EncryptedDataDetail* properties. The decrypt method will decrypt the XML document.
The class supports encrypting and decrypting with a shared symmetric_key, and also using asymmetric encryption to encrypt the symmetric_key (session key) via the RecipientCert* and Cer* properties.
Encrypt
To begin first specify a XML document by setting input_file, or input_xml.
The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.
The symmetric_key property specifies the key which will be used to encrypt the data.
If the RecipientCert* properties are set, then the symmetric_key will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (symmetric_key) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, recipient_cert MUST have a RSA key, not a DSA key.
If the RecipientCert* properties are not set, then the recipient must know the value of symmetric_key before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.
Optionally set encrypting_algorithm, and then call encrypt to encrypt the XML.
The following properties are applicable when calling this method:
- symmetric_key (required)
- encrypting_algorithm
- EncryptedDataDetail*
- RecipientCert*
- KeyName
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
Decrypt
To begin first specify a XML document by setting input_file, or input_xml.
The symmetric_key property specifies the key used to decrypt the data. This may be set before calling decrypt or inside the on_encrypted_data_info event. The on_encrypted_data_info event fires once for each encrypted element when decrypt is called.
If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling decrypt. The certificate will be used to decrypt the encrypted session key. In this case the symmetric_key property is ignored.
The following properties are applicable when calling this method:
- symmetric_key
- certificate
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
cert_encoded | This is the certificate (PEM/Base64 encoded). |
cert_store | This is the name of the certificate store for the client certificate. |
cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
cert_store_type | This is the type of certificate store for this certificate. |
cert_subject | This is the subject of the certificate used for client authentication. |
encrypted_data_detail_count | The number of records in the EncryptedDataDetail arrays. |
encrypted_data_detail_id | This property is an optional identifier for the encrypted data. |
encrypted_data_detail_mime_type | This property specifies the MIME type of the encrypted data. |
encrypted_data_detail_scope | This property specifies the scope of the encryption. |
encrypted_data_detail_xml_element | This property specifies the XPath to the element which will be encrypted. |
encrypting_algorithm | Then encryption algorithm used when encrypting. |
input_file | The XML file to process. |
input_xml | The XML to process. |
output_file | The output file. |
output_xml | The output XML after processing. |
overwrite | Indicates whether or not the class should overwrite files. |
recipient_cert_encoded | This is the certificate (PEM/Base64 encoded). |
recipient_cert_store | This is the name of the certificate store for the client certificate. |
recipient_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
recipient_cert_store_type | This is the type of certificate store for this certificate. |
recipient_cert_subject | This is the subject of the certificate used for client authentication. |
symmetric_key | The symmetric key used to encrypt and decrypt the XML. |
use_oaep | Whether to use Optimal Asymmetric Encryption Padding (OAEP). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
decrypt | Decrypts the XML. |
do_events | Processes events from the internal message queue. |
encrypt | Encrypts the XML. |
reset | Resets the class. |
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_encrypted_data_info | Fired once for each encrypted element when Decrypt is called. |
on_error | Fired when information is available about errors during data delivery. |
on_progress | Fired as progress is made. |
on_status | Provides information about the current operation. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
DecryptWithCryptoAPI | Whether to use the Crypto API for decrypt operations. |
EncryptedKeyXPath | The XPath of the EncryptedKey element. |
KeyName | The name of the key used to encrypt the XML. |
LogLevel | Specifies the level of detail that is logged. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used with OAEP. |
OAEPParams | The hex encoded OAEP parameters. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used with OAEP. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
ReadFromProgressEvent | Whether to read input data from inside the progress event. |
WriteToProgressEvent | Whether to write output data so it is accessible from inside the progress event. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_cert_encoded() -> bytes: ... def set_cert_encoded(value: bytes) -> None: ...
cert_encoded = property(get_cert_encoded, set_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The cert_store and cert_subject properties also may be used to specify a certificate.
When cert_encoded is set, a search is initiated in the current cert_store for the private key of the certificate. If the key is found, cert_subject is updated to reflect the full subject of the selected certificate; otherwise, cert_subject is set to an empty string.
cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_cert_store() -> bytes: ... def set_cert_store(value: bytes) -> None: ...
cert_store = property(get_cert_store, set_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password protected, specify the password in cert_store_password.
cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_cert_store_password() -> str: ... def set_cert_store_password(value: str) -> None: ...
cert_store_password = property(get_cert_store_password, set_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_cert_store_type() -> int: ... def set_cert_store_type(value: int) -> None: ...
cert_store_type = property(get_cert_store_type, set_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_cert_subject() -> str: ... def set_cert_subject(value: str) -> None: ...
cert_subject = property(get_cert_subject, set_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
encrypted_data_detail_count Property
The number of records in the EncryptedDataDetail arrays.
Syntax
def get_encrypted_data_detail_count() -> int: ... def set_encrypted_data_detail_count(value: int) -> None: ...
encrypted_data_detail_count = property(get_encrypted_data_detail_count, set_encrypted_data_detail_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- encrypted_data_detail_id
- encrypted_data_detail_mime_type
- encrypted_data_detail_scope
- encrypted_data_detail_xml_element
encrypted_data_detail_id Property
This property is an optional identifier for the encrypted data.
Syntax
def get_encrypted_data_detail_id(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_id(encrypted_data_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property is an optional identifier for the encrypted data.
The encrypted_data_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the encrypted_data_detail_count property.
encrypted_data_detail_mime_type Property
This property specifies the MIME type of the encrypted data.
Syntax
def get_encrypted_data_detail_mime_type(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_mime_type(encrypted_data_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property specifies the MIME type of the encrypted data. For example: "image/png". This property is optional.
The encrypted_data_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the encrypted_data_detail_count property.
encrypted_data_detail_scope Property
This property specifies the scope of the encryption.
Syntax
def get_encrypted_data_detail_scope(encrypted_data_detail_index: int) -> int: ... def set_encrypted_data_detail_scope(encrypted_data_detail_index: int, value: int) -> None: ...
Default Value
0
Remarks
This property specifies the scope of the encryption. When calling encrypt the entire XML element specified by encrypted_data_detail_xml_element may be encrypted, or only the content may be encrypted. This setting controls the scope of the encryption. Possible values are:
0 (sElement - default) | The entire XML element is encrypted. |
1 (sContent) | Only the content of the XML element is encrypted. |
The encrypted_data_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the encrypted_data_detail_count property.
encrypted_data_detail_xml_element Property
This property specifies the XPath to the element which will be encrypted.
Syntax
def get_encrypted_data_detail_xml_element(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_xml_element(encrypted_data_detail_index: int, value: str) -> None: ...
Default Value
"/"
Remarks
This property specifies the XPath to the element which will be encrypted. For instance:
/root/myElement | XPath syntax |
/root/[1] | XPath syntax using an index |
/root/ns:myElement | XPath syntax where the element has a namespace |
myElement | Just the element name |
@id=myid | Attribute selector: This will select an element with an attribute "id" whose value is "myid". |
/root/myElement[1]/ns:name2[@attr=attrValue] | XPath syntax using an index and attribute selector |
The encrypted_data_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the encrypted_data_detail_count property.
encrypting_algorithm Property
Then encryption algorithm used when encrypting.
Syntax
def get_encrypting_algorithm() -> str: ... def set_encrypting_algorithm(value: str) -> None: ...
encrypting_algorithm = property(get_encrypting_algorithm, set_encrypting_algorithm)
Default Value
"3DES"
Remarks
This property specifies the encryption algorithm to use when encrypting. Possible values are:
- "3DES" (default)
- "DES"
- "AES128"
- "AES192"
- "AES256"
input_file Property
The XML file to process.
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
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- input_file
- input_xml
- output_file
- output_xml: The output data is written to this property if no other destination is specified.
input_xml Property
The XML to process.
Syntax
def get_input_xml() -> str: ... def set_input_xml(value: str) -> None: ...
input_xml = property(get_input_xml, set_input_xml)
Default Value
""
Remarks
This property specifies the XML to be processed.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- input_file
- input_xml
- output_file
- output_xml: The output data is written to this property if no other destination is specified.
output_file Property
The output file.
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
This property specifies the file to which the output will be written. This may be set to an absolute or relative path.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
output_xml Property
The output XML after processing.
Syntax
def get_output_xml() -> str: ... def set_output_xml(value: str) -> None: ...
output_xml = property(get_output_xml, set_output_xml)
Default Value
""
Remarks
This property will be populated with the output from the operation if output_file is not set.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
overwrite Property
Indicates whether or not the class should overwrite files.
Syntax
def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ...
overwrite = property(get_overwrite, set_overwrite)
Default Value
FALSE
Remarks
This property indicates whether or not the class will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.
recipient_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_recipient_cert_encoded() -> bytes: ... def set_recipient_cert_encoded(value: bytes) -> None: ...
recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The recipient_cert_store and recipient_cert_subject properties also may be used to specify a certificate.
When recipient_cert_encoded is set, a search is initiated in the current recipient_cert_store for the private key of the certificate. If the key is found, recipient_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, recipient_cert_subject is set to an empty string.
recipient_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_recipient_cert_store() -> bytes: ... def set_recipient_cert_store(value: bytes) -> None: ...
recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password protected, specify the password in recipient_cert_store_password.
recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
recipient_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_recipient_cert_store_password() -> str: ... def set_recipient_cert_store_password(value: str) -> None: ...
recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
recipient_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_recipient_cert_store_type() -> int: ... def set_recipient_cert_store_type(value: int) -> None: ...
recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the recipient_cert_store and set recipient_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
recipient_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_recipient_cert_subject() -> str: ... def set_recipient_cert_subject(value: str) -> None: ...
recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
symmetric_key Property
The symmetric key used to encrypt and decrypt the XML.
Syntax
def get_symmetric_key() -> bytes: ... def set_symmetric_key(value: bytes) -> None: ...
symmetric_key = property(get_symmetric_key, set_symmetric_key)
Default Value
""
Remarks
This property specifies the symmetric key used to encrypt and decrypt the XML.
Encrypt Notes
When calling encrypt if the RecipientCert* properties are set, then the symmetric_key will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the symmetric_key allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the symmetric_key is required by the recipient.
If the RecipientCert* properties are set and symmetric_key is left empty, then a symmetric_key value will automatically be generated by the class when encrypt is called.
When calling encrypt if the RecipientCert* properties are are not set, then the symmetric_key value must be known by the recipient before the message can be decrypted.
Decrypt Notes
When calling decrypt if the data contains an encrypted key the class will attempt to use the certificate specified by the Cert* properties to decrypt the encrypted key and this property is ignored.
When calling decrypt if the data does not contain an encrypted key then symmetric_key must be set either before calling decrypt, or within the on_encrypted_data_info event.
Legal Key and Block Sizes (in bits)
AES | DES | 3DES | |
Minimum Key Size | 128 | 64 | 128 |
Maximum Key Size | 256 | 64 | 192 |
Key Size Step | 64 | 0 | 64 |
Block Size | 128 | 64 | 64 |
use_oaep Property
Whether to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
def get_use_oaep() -> bool: ... def set_use_oaep(value: bool) -> None: ...
use_oaep = property(get_use_oaep, set_use_oaep)
Default Value
FALSE
Remarks
This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the symmetric_key with the certificate specified by recipient_cert. It is only applicable when calling encrypt and recipient_cert is specified.
By default this value is False and the class will use PKCS1.
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.
decrypt Method
Decrypts the XML.
Syntax
def decrypt() -> None: ...
Remarks
This method decrypts the specified XML.
To begin first specify a XML document by setting input_file, or input_xml.
The symmetric_key property specifies the key used to decrypt the data. This may be set before calling decrypt or inside the on_encrypted_data_info event. The on_encrypted_data_info event fires once for each encrypted element when decrypt is called.
If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling decrypt. The certificate will be used to decrypt the encrypted session key. In this case the symmetric_key property is ignored.
The following properties are applicable when calling this method:
- symmetric_key
- certificate
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
encrypt Method
Encrypts the XML.
Syntax
def encrypt() -> None: ...
Remarks
This method encrypts the specified XML.
To begin first specify a XML document by setting input_file, or input_xml.
The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.
The symmetric_key property specifies the key which will be used to encrypt the data.
If the RecipientCert* properties are set, then the symmetric_key will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (symmetric_key) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, recipient_cert MUST have a RSA key, not a DSA key.
If the RecipientCert* properties are not set, then the recipient must know the value of symmetric_key before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.
Optionally set encrypting_algorithm, and then call encrypt to encrypt the XML.
The following properties are applicable when calling this method:
- symmetric_key (required)
- encrypting_algorithm
- EncryptedDataDetail*
- RecipientCert*
- KeyName
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- output_file
- output_xml: The output data is written to this property if no other destination is specified.
reset Method
Resets the class.
Syntax
def reset() -> None: ...
Remarks
When called, the component will reset all of its properties to their default values.
on_encrypted_data_info Event
Fired once for each encrypted element when Decrypt is called.
Syntax
class XMLEncryptEncryptedDataInfoEventParams(object): @property def encrypted_data_id() -> str: ... @property def scope() -> int: ... @property def mime_type() -> str: ... # In class XMLEncrypt: @property def on_encrypted_data_info() -> Callable[[XMLEncryptEncryptedDataInfoEventParams], None]: ... @on_encrypted_data_info.setter def on_encrypted_data_info(event_hook: Callable[[XMLEncryptEncryptedDataInfoEventParams], None]) -> None: ...
Remarks
This event fires once for each encrypted element in the XML document when decrypt is called. The parameters of this event provide information about the encrypted data. Additionally, the KeyName setting may be queried to identify the encryption key. symmetric_key may be set from within this event.
EncryptedDataId is the Id of the encrypted data (if any).
Scope indicates the scope of the encrypted data. This defines whether the entire XML element was encrypted, or only the content. Possible values are:
0 | Element |
1 | Content |
MIMEType holds the MIME type of the encrypted data (if any). For example: "image/png".
on_error Event
Fired when information is available about errors during data delivery.
Syntax
class XMLEncryptErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class XMLEncrypt: @property def on_error() -> Callable[[XMLEncryptErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[XMLEncryptErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_progress Event
Fired as progress is made.
Syntax
class XMLEncryptProgressEventParams(object): @property def bytes_processed() -> int: ... @property def percent_processed() -> int: ... @property def operation() -> int: ... @property def is_eof() -> bool: ... @is_eof.setter def is_eof(value) -> None: ... # In class XMLEncrypt: @property def on_progress() -> Callable[[XMLEncryptProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[XMLEncryptProgressEventParams], None]) -> None: ...
Remarks
This event is fired automatically as data is processed by the class.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:
0 | None |
1 | Read |
2 | Write |
The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.
on_status Event
Provides information about the current operation.
Syntax
class XMLEncryptStatusEventParams(object): @property def message() -> str: ... # In class XMLEncrypt: @property def on_status() -> Callable[[XMLEncryptStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[XMLEncryptStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.
The level of detail is controlled by the LogLevel setting.
XMLEncrypt 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.XMLEnc Config Settings
Note: This functionality is only available on Windows.
Note that this value is only informative, it does not affect processing.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
Note: This setting is not applicable when UseFIPSCompliantAPI is set to True or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate OAEPRSAHashAlgorithm and OAEPMGF1HashAlgorithm values. In this case the OAEPRSAHashAlgorithm is also used for MGF1.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
XMLEncrypt Errors
XMLEnc Errors
607 Failed to write output. | |
609 Could not find encrypted data. | |
610 Invalid encrypted data. | |
611 Failed parsing certificate data. | |
612 SymmetricKey or RecipientCert must be set. |
XML Errors
101 Invalid attribute index. | |
102 No attributes available. | |
103 Invalid namespace index. | |
104 No namespaces available. | |
105 Invalid element index. | |
106 No elements available. | |
107 Attribute does not exist. | |
201 Unbalanced element tag. | |
202 Unknown element prefix (can't find namespace). | |
203 Unknown attribute prefix (can't find namespace). | |
204 Invalid XML markup. | |
205 Invalid end state for parser. | |
206 Document contains unbalanced elements. | |
207 Invalid xpath. | |
208 No such child. | |
209 Top element does not match start of path. | |
210 DOM tree unavailable (set build_dom to true and reparse). | |
302 Can't open file. | |
401 Invalid XML would be generated. | |
402 An invalid XML name has been specified. |