Struct ipworksencrypt::XMLEncrypt

Properties   Methods   Events   Config Settings   Errors  

The XMLEncrypt struct is used to encrypt and decrypt XML.

Syntax

ipworksencrypt::XMLEncrypt

Remarks

The XMLEncrypt struct 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 encrypted_data_details. The decrypt method will decrypt the XML document.

The struct supports encrypting and decrypting with a shared symmetric_key, and also using asymmetric encryption to encrypt the symmetric_key (session key) via the recipient_cert and certificate properties.

Encrypt

To begin first specify a XML document by setting input_file, or input_xml.

The encrypted_data_details property 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 recipient_cert property is 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 recipient_cert property is 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
• encrypted_data_details
• recipient_cert
• KeyName

Input and Output Properties

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

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 certificate property 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 struct 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

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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the XMLEncrypt struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of XMLEncrypt when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

cert_effective_date property (XMLEncrypt Struct)

The date on which this certificate becomes valid.

Syntax

fn cert_effective_date(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

cert_expiration_date property (XMLEncrypt Struct)

The date on which the certificate expires.

Syntax

fn cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

cert_extended_key_usage property (XMLEncrypt Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

cert_fingerprint property (XMLEncrypt Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

cert_fingerprint_sha1 property (XMLEncrypt Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

cert_fingerprint_sha256 property (XMLEncrypt Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

cert_issuer property (XMLEncrypt Struct)

The issuer of the certificate.

Syntax

fn cert_issuer(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

cert_private_key property (XMLEncrypt Struct)

The private key of the certificate (if available).

Syntax

fn cert_private_key(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The cert_private_key may be available but not exportable. In this case, cert_private_key returns an empty string.

This property is read-only.

Data Type

String

cert_private_key_available property (XMLEncrypt Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError> 

Default Value

false

Remarks

Whether a cert_private_key is available for the selected certificate. If cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

cert_private_key_container property (XMLEncrypt Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The name of the cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

cert_public_key property (XMLEncrypt Struct)

The public key of the certificate.

Syntax

fn cert_public_key(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

cert_public_key_algorithm property (XMLEncrypt Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

cert_public_key_length property (XMLEncrypt Struct)

The length of the certificate's public key (in bits).

Syntax

fn cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

cert_serial_number property (XMLEncrypt Struct)

The serial number of the certificate encoded as a string.

Syntax

fn cert_serial_number(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

cert_signature_algorithm property (XMLEncrypt Struct)

The text description of the certificate's signature algorithm.

Syntax

fn cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

cert_store property (XMLEncrypt Struct)

The name of the certificate store for the client certificate.

Syntax

fn cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

"MY"

Remarks

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:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

cert_store_password property (XMLEncrypt Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn cert_store_password(&self ) -> Result<String, IPWorksEncryptError> 
fn set_cert_store_password(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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.

Data Type

String

cert_store_type property (XMLEncrypt Struct)

The type of certificate store for this certificate.

Syntax

fn cert_store_type(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_cert_store_type(&self, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

cert_subject_alt_names property (XMLEncrypt Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

cert_thumbprint_md5 property (XMLEncrypt Struct)

The MD5 hash of the certificate.

Syntax

fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

cert_thumbprint_sha1 property (XMLEncrypt Struct)

The SHA-1 hash of the certificate.

Syntax

fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

cert_thumbprint_sha256 property (XMLEncrypt Struct)

The SHA-256 hash of the certificate.

Syntax

fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

cert_usage property (XMLEncrypt Struct)

The text description of UsageFlags .

Syntax

fn cert_usage(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The text description of cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

cert_usage_flags property (XMLEncrypt Struct)

The flags that show intended use for the certificate.

Syntax

fn cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of cert_usage_flags is a combination of the following flags:

Please see the cert_usage property for a text representation of cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

cert_version property (XMLEncrypt Struct)

The certificate's version number.

Syntax

fn cert_version(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

cert_subject property (XMLEncrypt Struct)

The subject of the certificate used for client authentication.

Syntax

fn cert_subject(&self ) -> Result<String, IPWorksEncryptError> 
fn set_cert_subject(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

cert_encoded property (XMLEncrypt Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

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.

Data Type

Vec

encrypted_data_detail_count property (XMLEncrypt Struct)

The number of records in the EncryptedDataDetail arrays.

Syntax

fn encrypted_data_detail_count(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_encrypted_data_detail_count(&self, value : i32) ->  Option<IPWorksEncryptError> 

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

The array indices start at 0 and end at encrypted_data_detail_count - 1.

Data Type

i32

encrypted_data_detail_id property (XMLEncrypt Struct)

This property is an optional identifier for the encrypted data.

Syntax

fn encrypted_data_detail_id(&self , EncryptedDataDetailIndex : i32) -> Result<String, IPWorksEncryptError> 
fn set_encrypted_data_detail_id(&self, EncryptedDataDetailIndex : i32, value : &str) ->  Option<IPWorksEncryptError> 
fn set_encrypted_data_detail_id_ref(&self, EncryptedDataDetailIndex : i32, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property is an optional identifier for the encrypted data.

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

Data Type

String

encrypted_data_detail_mime_type property (XMLEncrypt Struct)

This property specifies the MIME type of the encrypted data.

Syntax

fn encrypted_data_detail_mime_type(&self , EncryptedDataDetailIndex : i32) -> Result<String, IPWorksEncryptError> 
fn set_encrypted_data_detail_mime_type(&self, EncryptedDataDetailIndex : i32, value : &str) ->  Option<IPWorksEncryptError> 
fn set_encrypted_data_detail_mime_type_ref(&self, EncryptedDataDetailIndex : i32, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property specifies the MIME type of the encrypted data. For example: "image/png". This property is optional.

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

Data Type

String

encrypted_data_detail_scope property (XMLEncrypt Struct)

This property specifies the scope of the encryption.

Syntax

fn encrypted_data_detail_scope(&self , EncryptedDataDetailIndex : i32) -> Result<i32, IPWorksEncryptError> 
fn set_encrypted_data_detail_scope(&self, EncryptedDataDetailIndex : i32, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // Element
1   // Content

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:

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

Data Type

i32

encrypted_data_detail_xml_element property (XMLEncrypt Struct)

This property specifies the XPath to the element which will be encrypted.

Syntax

fn encrypted_data_detail_xml_element(&self , EncryptedDataDetailIndex : i32) -> Result<String, IPWorksEncryptError> 
fn set_encrypted_data_detail_xml_element(&self, EncryptedDataDetailIndex : i32, value : &str) ->  Option<IPWorksEncryptError> 
fn set_encrypted_data_detail_xml_element_ref(&self, EncryptedDataDetailIndex : i32, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

"/"

Remarks

This property specifies the XPath to the element which will be encrypted. For instance:

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

Data Type

String

encrypting_algorithm property (XMLEncrypt Struct)

Then encryption algorithm used when encrypting.

Syntax

fn encrypting_algorithm(&self ) -> Result<String, IPWorksEncryptError> 
fn set_encrypting_algorithm(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_encrypting_algorithm_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

"3DES"

Remarks

This property specifies the encryption algorithm to use when encrypting. Possible values are:

• "3DES" (default)
• "DES"
• "AES128"
• "AES192"
• "AES256"

Data Type

String

input_file property (XMLEncrypt Struct)

The XML file to process.

Syntax

fn input_file(&self ) -> Result<String, IPWorksEncryptError> 
fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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

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.

Data Type

String

input_xml property (XMLEncrypt Struct)

The XML to process.

Syntax

fn input_xml(&self ) -> Result<String, IPWorksEncryptError> 
fn set_input_xml(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_input_xml_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property specifies the XML to be processed.

Input and Output Properties

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

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.

Data Type

String

output_file property (XMLEncrypt Struct)

The output file.

Syntax

fn output_file(&self ) -> Result<String, IPWorksEncryptError> 
fn set_output_file(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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

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.

Data Type

String

output_xml property (XMLEncrypt Struct)

The output XML after processing.

Syntax

fn output_xml(&self ) -> Result<String, IPWorksEncryptError> 
fn set_output_xml(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_output_xml_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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

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.

Data Type

String

overwrite property (XMLEncrypt Struct)

Indicates whether or not the struct should overwrite files.

Syntax

fn overwrite(&self ) -> Result<bool, IPWorksEncryptError> 
fn set_overwrite(&self, value : bool) ->  Option<IPWorksEncryptError> 

Default Value

false

Remarks

This property indicates whether or not the struct 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.

Data Type

bool

recipient_cert_effective_date property (XMLEncrypt Struct)

The date on which this certificate becomes valid.

Syntax

fn recipient_cert_effective_date(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

recipient_cert_expiration_date property (XMLEncrypt Struct)

The date on which the certificate expires.

Syntax

fn recipient_cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

recipient_cert_extended_key_usage property (XMLEncrypt Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn recipient_cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

recipient_cert_fingerprint property (XMLEncrypt Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn recipient_cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

recipient_cert_fingerprint_sha1 property (XMLEncrypt Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn recipient_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

recipient_cert_fingerprint_sha256 property (XMLEncrypt Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn recipient_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

recipient_cert_issuer property (XMLEncrypt Struct)

The issuer of the certificate.

Syntax

fn recipient_cert_issuer(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

recipient_cert_private_key property (XMLEncrypt Struct)

The private key of the certificate (if available).

Syntax

fn recipient_cert_private_key(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The recipient_cert_private_key may be available but not exportable. In this case, recipient_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

recipient_cert_private_key_available property (XMLEncrypt Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn recipient_cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError> 

Default Value

false

Remarks

Whether a recipient_cert_private_key is available for the selected certificate. If recipient_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

recipient_cert_private_key_container property (XMLEncrypt Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn recipient_cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The name of the recipient_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

recipient_cert_public_key property (XMLEncrypt Struct)

The public key of the certificate.

Syntax

fn recipient_cert_public_key(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

recipient_cert_public_key_algorithm property (XMLEncrypt Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn recipient_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

recipient_cert_public_key_length property (XMLEncrypt Struct)

The length of the certificate's public key (in bits).

Syntax

fn recipient_cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

recipient_cert_serial_number property (XMLEncrypt Struct)

The serial number of the certificate encoded as a string.

Syntax

fn recipient_cert_serial_number(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

recipient_cert_signature_algorithm property (XMLEncrypt Struct)

The text description of the certificate's signature algorithm.

Syntax

fn recipient_cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

recipient_cert_store property (XMLEncrypt Struct)

The name of the certificate store for the client certificate.

Syntax

fn recipient_cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_recipient_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_recipient_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

"MY"

Remarks

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:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

recipient_cert_store_password property (XMLEncrypt Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn recipient_cert_store_password(&self ) -> Result<String, IPWorksEncryptError> 
fn set_recipient_cert_store_password(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_recipient_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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.

Data Type

String

recipient_cert_store_type property (XMLEncrypt Struct)

The type of certificate store for this certificate.

Syntax

fn recipient_cert_store_type(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_recipient_cert_store_type(&self, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

recipient_cert_subject_alt_names property (XMLEncrypt Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn recipient_cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

recipient_cert_thumbprint_md5 property (XMLEncrypt Struct)

The MD5 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

recipient_cert_thumbprint_sha1 property (XMLEncrypt Struct)

The SHA-1 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

recipient_cert_thumbprint_sha256 property (XMLEncrypt Struct)

The SHA-256 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

recipient_cert_usage property (XMLEncrypt Struct)

The text description of UsageFlags .

Syntax

fn recipient_cert_usage(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The text description of recipient_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

recipient_cert_usage_flags property (XMLEncrypt Struct)

The flags that show intended use for the certificate.

Syntax

fn recipient_cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of recipient_cert_usage_flags is a combination of the following flags:

Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

recipient_cert_version property (XMLEncrypt Struct)

The certificate's version number.

Syntax

fn recipient_cert_version(&self ) -> Result<String, IPWorksEncryptError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

recipient_cert_subject property (XMLEncrypt Struct)

The subject of the certificate used for client authentication.

Syntax

fn recipient_cert_subject(&self ) -> Result<String, IPWorksEncryptError> 
fn set_recipient_cert_subject(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_recipient_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

recipient_cert_encoded property (XMLEncrypt Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn recipient_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_recipient_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_recipient_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

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.

Data Type

Vec

symmetric_key property (XMLEncrypt Struct)

The symmetric key used to encrypt and decrypt the XML.

Syntax

fn symmetric_key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_symmetric_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_symmetric_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property specifies the symmetric key used to encrypt and decrypt the XML.

Encrypt Notes

When calling encrypt if the recipient_cert property is 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 recipient_cert property is set and symmetric_key is left empty, then a symmetric_key value will automatically be generated by the struct when encrypt is called.

When calling encrypt if the recipient_cert property is 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 struct will attempt to use the certificate specified by the certificate property 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)

Data Type

Vec

use_oaep property (XMLEncrypt Struct)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

fn use_oaep(&self ) -> Result<bool, IPWorksEncryptError> 
fn set_use_oaep(&self, value : bool) ->  Option<IPWorksEncryptError> 

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 struct will use PKCS1.

Data Type

bool

config method (XMLEncrypt Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>

Remarks

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

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

Decrypts the XML.

Syntax

fn decrypt(&self) -> Result<(), IPWorksEncryptError>

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 certificate property 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 struct 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

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 (XMLEncrypt Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksEncryptError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

encrypt method (XMLEncrypt Struct)

Encrypts the XML.

Syntax

fn encrypt(&self) -> Result<(), IPWorksEncryptError>

Remarks

This method encrypts the specified XML.

To begin first specify a XML document by setting input_file, or input_xml.

The encrypted_data_details property 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 recipient_cert property is 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 recipient_cert property is 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
• encrypted_data_details
• recipient_cert
• KeyName

Input and Output Properties

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

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 (XMLEncrypt Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksEncryptError>

Remarks

When called, the component will reset all of its properties to their default values.

on_encrypted_data_info event (XMLEncrypt Struct)

Fired once for each encrypted element when Decrypt is called.

Syntax

// XMLEncryptEncryptedDataInfoEventArgs carries the XMLEncrypt EncryptedDataInfo event's parameters.
pub struct XMLEncryptEncryptedDataInfoEventArgs {
  fn encrypted_data_id(&self) -> &String
  fn scope(&self) -> i32
  fn mime_type(&self) -> &String
}

// XMLEncryptEncryptedDataInfoEvent defines the signature of the XMLEncrypt EncryptedDataInfo event's handler function.
pub trait XMLEncryptEncryptedDataInfoEvent {
  fn on_encrypted_data_info(&self, sender : XMLEncrypt, e : &mut XMLEncryptEncryptedDataInfoEventArgs);
}

impl <'a> XMLEncrypt<'a> {
  pub fn on_encrypted_data_info(&self) -> &'a dyn XMLEncryptEncryptedDataInfoEvent;
  pub fn set_on_encrypted_data_info(&mut self, value : &'a dyn XMLEncryptEncryptedDataInfoEvent);
  ...
}

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:

MIMEType holds the MIME type of the encrypted data (if any). For example: "image/png".

on_error event (XMLEncrypt Struct)

Fired when information is available about errors during data delivery.

Syntax

// XMLEncryptErrorEventArgs carries the XMLEncrypt Error event's parameters.
pub struct XMLEncryptErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// XMLEncryptErrorEvent defines the signature of the XMLEncrypt Error event's handler function.
pub trait XMLEncryptErrorEvent {
  fn on_error(&self, sender : XMLEncrypt, e : &mut XMLEncryptErrorEventArgs);
}

impl <'a> XMLEncrypt<'a> {
  pub fn on_error(&self) -> &'a dyn XMLEncryptErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn XMLEncryptErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code 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 (XMLEncrypt Struct)

Fired as progress is made.

Syntax

// XMLEncryptProgressEventArgs carries the XMLEncrypt Progress event's parameters.
pub struct XMLEncryptProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
  fn operation(&self) -> i32
  fn is_eof(&self) -> bool
  fn set_is_eof(&self, value : bool)
}

// XMLEncryptProgressEvent defines the signature of the XMLEncrypt Progress event's handler function.
pub trait XMLEncryptProgressEvent {
  fn on_progress(&self, sender : XMLEncrypt, e : &mut XMLEncryptProgressEventArgs);
}

impl <'a> XMLEncrypt<'a> {
  pub fn on_progress(&self) -> &'a dyn XMLEncryptProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn XMLEncryptProgressEvent);
  ...
}

Remarks

This event is fired automatically as data is processed by the struct.

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:

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 struct. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

on_status event (XMLEncrypt Struct)

Provides information about the current operation.

Syntax

// XMLEncryptStatusEventArgs carries the XMLEncrypt Status event's parameters.
pub struct XMLEncryptStatusEventArgs {
  fn message(&self) -> &String
}

// XMLEncryptStatusEvent defines the signature of the XMLEncrypt Status event's handler function.
pub trait XMLEncryptStatusEvent {
  fn on_status(&self, sender : XMLEncrypt, e : &mut XMLEncryptStatusEventArgs);
}

impl <'a> XMLEncrypt<'a> {
  pub fn on_status(&self) -> &'a dyn XMLEncryptStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn XMLEncryptStatusEvent);
  ...
}

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.

Config Settings (XMLEncrypt Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

XMLEnc Config Settings

Base Config Settings

Trappable Errors (XMLEncrypt Struct)

XMLEnc Errors

XML Errors