XMLEncrypt Class

Properties   Methods   Events   Config Settings   Errors  

The XMLEncrypt class is used to encrypt and decrypt XML.

Class Name

IPWorksEncrypt_XMLEncrypt

Procedural Interface

 ipworksencrypt_xmlencrypt_open();
 ipworksencrypt_xmlencrypt_close($res);
 ipworksencrypt_xmlencrypt_register_callback($res, $id, $function);
 ipworksencrypt_xmlencrypt_get_last_error($res);
 ipworksencrypt_xmlencrypt_get_last_error_code($res);
 ipworksencrypt_xmlencrypt_set($res, $id, $index, $value);
 ipworksencrypt_xmlencrypt_get($res, $id, $index);
 ipworksencrypt_xmlencrypt_do_config($res, $configurationstring);
 ipworksencrypt_xmlencrypt_do_decrypt($res);
 ipworksencrypt_xmlencrypt_do_doevents($res);
 ipworksencrypt_xmlencrypt_do_encrypt($res);
 ipworksencrypt_xmlencrypt_do_reset($res);

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 SymmetricKey, and also using asymmetric encryption to encrypt the SymmetricKey (session key) via the RecipientCert* and Cer* properties.

Encrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey 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 (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• 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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

Decrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo 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 SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• 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:

• InputFile
• InputXML

• OutputFile
• OutputXML: 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.

Method List

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

Event List

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

Config Settings

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

CertEncoded Property (IPWorksEncrypt_XMLEncrypt Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getCertEncoded();


public function setCertEncoded($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 2 );


ipworksencrypt_xmlencrypt_set($res, 2, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

CertStore Property (IPWorksEncrypt_XMLEncrypt Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getCertStore();


public function setCertStore($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 18 );


ipworksencrypt_xmlencrypt_set($res, 18, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject 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 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).

Data Type

Binary String

CertStorePassword Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertStorePassword();


public function setCertStorePassword($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 19 );


ipworksencrypt_xmlencrypt_set($res, 19, $value );

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

CertStoreType Property (IPWorksEncrypt_XMLEncrypt Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();


public function setCertStoreType($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 20 );


ipworksencrypt_xmlencrypt_set($res, 20, $value );

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:

 
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

CertSubject Property (IPWorksEncrypt_XMLEncrypt Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getCertSubject();


public function setCertSubject($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 21 );


ipworksencrypt_xmlencrypt_set($res, 21, $value );

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:

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

Data Type

String

EncryptedDataDetailCount Property (IPWorksEncrypt_XMLEncrypt Class)

The number of records in the EncryptedDataDetail arrays.

Object Oriented Interface

public function getEncryptedDataDetailCount();


public function setEncryptedDataDetailCount($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 29 );


ipworksencrypt_xmlencrypt_set($res, 29, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptedDataDetailId
• EncryptedDataDetailMIMEType
• EncryptedDataDetailScope
• EncryptedDataDetailXMLElement

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

This property is not available at design time.

Data Type

Integer

EncryptedDataDetailId Property (IPWorksEncrypt_XMLEncrypt Class)

This property is an optional identifier for the encrypted data.

Object Oriented Interface

public function getEncryptedDataDetailId($encrypteddatadetailindex);


public function setEncryptedDataDetailId($encrypteddatadetailindex, $value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 30 , $encrypteddatadetailindex);


ipworksencrypt_xmlencrypt_set($res, 30, $value , $encrypteddatadetailindex);

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.

This property is not available at design time.

Data Type

String

EncryptedDataDetailMIMEType Property (IPWorksEncrypt_XMLEncrypt Class)

This property specifies the MIME type of the encrypted data.

Object Oriented Interface

public function getEncryptedDataDetailMIMEType($encrypteddatadetailindex);


public function setEncryptedDataDetailMIMEType($encrypteddatadetailindex, $value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 31 , $encrypteddatadetailindex);


ipworksencrypt_xmlencrypt_set($res, 31, $value , $encrypteddatadetailindex);

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.

This property is not available at design time.

Data Type

String

EncryptedDataDetailScope Property (IPWorksEncrypt_XMLEncrypt Class)

This property specifies the scope of the encryption.

Object Oriented Interface

public function getEncryptedDataDetailScope($encrypteddatadetailindex);


public function setEncryptedDataDetailScope($encrypteddatadetailindex, $value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 32 , $encrypteddatadetailindex);


ipworksencrypt_xmlencrypt_set($res, 32, $value , $encrypteddatadetailindex);

Default Value

0

Remarks

This property specifies the scope of the encryption. When calling Encrypt the entire XML element specified by EncryptedDataDetailXMLElement 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.

This property is not available at design time.

Data Type

Integer

EncryptedDataDetailXMLElement Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getEncryptedDataDetailXMLElement($encrypteddatadetailindex);


public function setEncryptedDataDetailXMLElement($encrypteddatadetailindex, $value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 33 , $encrypteddatadetailindex);


ipworksencrypt_xmlencrypt_set($res, 33, $value , $encrypteddatadetailindex);

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.

This property is not available at design time.

Data Type

String

EncryptingAlgorithm Property (IPWorksEncrypt_XMLEncrypt Class)

Then encryption algorithm used when encrypting.

Object Oriented Interface

public function getEncryptingAlgorithm();


public function setEncryptingAlgorithm($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 34 );


ipworksencrypt_xmlencrypt_set($res, 34, $value );

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

InputFile Property (IPWorksEncrypt_XMLEncrypt Class)

The XML file to process.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 35 );


ipworksencrypt_xmlencrypt_set($res, 35, $value );

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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputXML Property (IPWorksEncrypt_XMLEncrypt Class)

The XML to process.

Object Oriented Interface

public function getInputXML();


public function setInputXML($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 36 );


ipworksencrypt_xmlencrypt_set($res, 36, $value );

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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFile Property (IPWorksEncrypt_XMLEncrypt Class)

The output file.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 37 );


ipworksencrypt_xmlencrypt_set($res, 37, $value );

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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputXML Property (IPWorksEncrypt_XMLEncrypt Class)

The output XML after processing.

Object Oriented Interface

public function getOutputXML();


public function setOutputXML($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 38 );


ipworksencrypt_xmlencrypt_set($res, 38, $value );

Default Value

''

Remarks

This property will be populated with the output from the operation if OutputFile 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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

Overwrite Property (IPWorksEncrypt_XMLEncrypt Class)

Indicates whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 39 );


ipworksencrypt_xmlencrypt_set($res, 39, $value );

Default Value

false

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

RecipientCertEncoded Property (IPWorksEncrypt_XMLEncrypt Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getRecipientCertEncoded();


public function setRecipientCertEncoded($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 41 );


ipworksencrypt_xmlencrypt_set($res, 41, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (IPWorksEncrypt_XMLEncrypt Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getRecipientCertStore();


public function setRecipientCertStore($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 57 );


ipworksencrypt_xmlencrypt_set($res, 57, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject 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 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).

Data Type

Binary String

RecipientCertStorePassword Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertStorePassword();


public function setRecipientCertStorePassword($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 58 );


ipworksencrypt_xmlencrypt_set($res, 58, $value );

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

RecipientCertStoreType Property (IPWorksEncrypt_XMLEncrypt Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getRecipientCertStoreType();


public function setRecipientCertStoreType($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 59 );


ipworksencrypt_xmlencrypt_set($res, 59, $value );

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:

 
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

RecipientCertSubject Property (IPWorksEncrypt_XMLEncrypt Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getRecipientCertSubject();


public function setRecipientCertSubject($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 60 );


ipworksencrypt_xmlencrypt_set($res, 60, $value );

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:

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

Data Type

String

SymmetricKey Property (IPWorksEncrypt_XMLEncrypt Class)

The symmetric key used to encrypt and decrypt the XML.

Object Oriented Interface

public function getSymmetricKey();


public function setSymmetricKey($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 68 );


ipworksencrypt_xmlencrypt_set($res, 68, $value );

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 SymmetricKey will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the SymmetricKey allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the SymmetricKey is required by the recipient.

If the RecipientCert* properties are set and SymmetricKey is left empty, then a SymmetricKey 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 SymmetricKey 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 SymmetricKey must be set either before calling Decrypt, or within the EncryptedDataInfo event.

Legal Key and Block Sizes (in bits)

This property is not available at design time.

Data Type

Binary String

UseOAEP Property (IPWorksEncrypt_XMLEncrypt Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Object Oriented Interface

public function getUseOAEP();


public function setUseOAEP($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 69 );


ipworksencrypt_xmlencrypt_set($res, 69, $value );

Default Value

false

Remarks

This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the SymmetricKey with the certificate specified by RecipientCert. It is only applicable when calling Encrypt and RecipientCert is specified.

By default this value is False and the class will use PKCS1.

Data Type

Boolean

Config Method (IPWorksEncrypt_XMLEncrypt Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksencrypt_xmlencrypt_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (IPWorksEncrypt_XMLEncrypt Class)

Decrypts the XML.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

ipworksencrypt_xmlencrypt_do_decrypt($res);

Remarks

This method decrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo 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 SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• 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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

DoEvents Method (IPWorksEncrypt_XMLEncrypt Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksencrypt_xmlencrypt_do_doevents($res);

Remarks

When DoEvents 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 (IPWorksEncrypt_XMLEncrypt Class)

Encrypts the XML.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

ipworksencrypt_xmlencrypt_do_encrypt($res);

Remarks

This method encrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey 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 (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• 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:

• InputFile
• InputXML

• OutputFile
• OutputXML: The output data is written to this property if no other destination is specified.

Reset Method (IPWorksEncrypt_XMLEncrypt Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_xmlencrypt_do_reset($res);

Remarks

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

EncryptedDataInfo Event (IPWorksEncrypt_XMLEncrypt Class)

Fired once for each encrypted element when Decrypt is called.

Object Oriented Interface

public function fireEncryptedDataInfo($param);

Procedural Interface

ipworksencrypt_xmlencrypt_register_callback($res, 1, array($this, 'fireEncryptedDataInfo'));

Parameter List

 'encrypteddataid'
 'scope'
 'mimetype'

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. SymmetricKey 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".

Error Event (IPWorksEncrypt_XMLEncrypt Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_xmlencrypt_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Progress Event (IPWorksEncrypt_XMLEncrypt Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_xmlencrypt_register_callback($res, 3, array($this, 'fireProgress'));

Parameter List

 'bytesprocessed'
 'percentprocessed'
 'operation'
 'iseof'

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:

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.

Status Event (IPWorksEncrypt_XMLEncrypt Class)

Provides information about the current operation.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworksencrypt_xmlencrypt_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

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

XMLEnc Config Settings

Base Config Settings

Trappable Errors (XMLEncrypt Class)

XMLEnc Errors

XML Errors