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 EncryptedDataDetails. 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 Certificate properties.

Encrypt

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

The EncryptedDataDetails property 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 property is 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 property is 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
• EncryptedDataDetails
• 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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

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

CertEffectiveDate Property (IPWorksEncrypt_XMLEncrypt Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getCertEffectiveDate();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 1 );

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

CertExpirationDate Property (IPWorksEncrypt_XMLEncrypt Class)

The date on which the certificate expires.

Object Oriented Interface

public function getCertExpirationDate();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 2 );

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

CertExtendedKeyUsage Property (IPWorksEncrypt_XMLEncrypt Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 3 );

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

CertFingerprint Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 4 );

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

CertFingerprintSHA1 Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 5 );

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

CertFingerprintSHA256 Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 6 );

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

CertIssuer Property (IPWorksEncrypt_XMLEncrypt Class)

The issuer of the certificate.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 7 );

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

CertPrivateKey Property (IPWorksEncrypt_XMLEncrypt Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getCertPrivateKey();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 8 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (IPWorksEncrypt_XMLEncrypt Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 9 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 10 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CertPublicKey Property (IPWorksEncrypt_XMLEncrypt Class)

The public key of the certificate.

Object Oriented Interface

public function getCertPublicKey();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 11 );

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

CertPublicKeyAlgorithm Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 12 );

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

CertPublicKeyLength Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertPublicKeyLength();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 13 );

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

Integer

CertSerialNumber Property (IPWorksEncrypt_XMLEncrypt Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getCertSerialNumber();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 14 );

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

CertSignatureAlgorithm Property (IPWorksEncrypt_XMLEncrypt Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 15 );

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

CertStore Property (IPWorksEncrypt_XMLEncrypt Class)

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, 16 );
ipworksencrypt_xmlencrypt_set($res, 16, $value );

Default Value

'MY'

Remarks

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

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, 17 );
ipworksencrypt_xmlencrypt_set($res, 17, $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)

The type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();
public function setCertStoreType($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 18 );
ipworksencrypt_xmlencrypt_set($res, 18, $value );

Default Value

0

Remarks

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:

Data Type

Integer

CertSubjectAltNames Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getCertSubjectAltNames();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 19 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (IPWorksEncrypt_XMLEncrypt Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintMD5();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 20 );

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

CertThumbprintSHA1 Property (IPWorksEncrypt_XMLEncrypt Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 21 );

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

CertThumbprintSHA256 Property (IPWorksEncrypt_XMLEncrypt Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 22 );

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

CertUsage Property (IPWorksEncrypt_XMLEncrypt Class)

The text description of UsageFlags .

Object Oriented Interface

public function getCertUsage();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 23 );

Default Value

''

Remarks

The text description of CertUsageFlags.

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

CertUsageFlags Property (IPWorksEncrypt_XMLEncrypt Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getCertUsageFlags();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 24 );

Default Value

0

Remarks

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

Please see the CertUsage property for a text representation of CertUsageFlags.

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

This property is read-only.

Data Type

Integer

CertVersion Property (IPWorksEncrypt_XMLEncrypt Class)

The certificate's version number.

Object Oriented Interface

public function getCertVersion();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 25 );

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

CertSubject Property (IPWorksEncrypt_XMLEncrypt Class)

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, 26 );
ipworksencrypt_xmlencrypt_set($res, 26, $value );

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

CertEncoded Property (IPWorksEncrypt_XMLEncrypt Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getCertEncoded();
public function setCertEncoded($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 27 );
ipworksencrypt_xmlencrypt_set($res, 27, $value );

Default Value

''

Remarks

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

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, 28 );
ipworksencrypt_xmlencrypt_set($res, 28, $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, 29 , $encrypteddatadetailindex);
ipworksencrypt_xmlencrypt_set($res, 29, $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, 30 , $encrypteddatadetailindex);
ipworksencrypt_xmlencrypt_set($res, 30, $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, 31 , $encrypteddatadetailindex);
ipworksencrypt_xmlencrypt_set($res, 31, $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, 32 , $encrypteddatadetailindex);
ipworksencrypt_xmlencrypt_set($res, 32, $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, 33 );
ipworksencrypt_xmlencrypt_set($res, 33, $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, 34 );
ipworksencrypt_xmlencrypt_set($res, 34, $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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• 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, 35 );
ipworksencrypt_xmlencrypt_set($res, 35, $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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• 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, 36 );
ipworksencrypt_xmlencrypt_set($res, 36, $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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• 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, 37 );
ipworksencrypt_xmlencrypt_set($res, 37, $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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• 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, 38 );
ipworksencrypt_xmlencrypt_set($res, 38, $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

RecipientCertEffectiveDate Property (IPWorksEncrypt_XMLEncrypt Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getRecipientCertEffectiveDate();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 39 );

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

RecipientCertExpirationDate Property (IPWorksEncrypt_XMLEncrypt Class)

The date on which the certificate expires.

Object Oriented Interface

public function getRecipientCertExpirationDate();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 40 );

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

RecipientCertExtendedKeyUsage Property (IPWorksEncrypt_XMLEncrypt Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getRecipientCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 41 );

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

RecipientCertFingerprint Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertFingerprint();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 42 );

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

RecipientCertFingerprintSHA1 Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 43 );

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

RecipientCertFingerprintSHA256 Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 44 );

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

RecipientCertIssuer Property (IPWorksEncrypt_XMLEncrypt Class)

The issuer of the certificate.

Object Oriented Interface

public function getRecipientCertIssuer();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 45 );

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

RecipientCertPrivateKey Property (IPWorksEncrypt_XMLEncrypt Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getRecipientCertPrivateKey();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 46 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

RecipientCertPrivateKeyAvailable Property (IPWorksEncrypt_XMLEncrypt Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getRecipientCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 47 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

RecipientCertPrivateKeyContainer Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 48 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

RecipientCertPublicKey Property (IPWorksEncrypt_XMLEncrypt Class)

The public key of the certificate.

Object Oriented Interface

public function getRecipientCertPublicKey();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 49 );

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

RecipientCertPublicKeyAlgorithm Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 50 );

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

RecipientCertPublicKeyLength Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertPublicKeyLength();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 51 );

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

Integer

RecipientCertSerialNumber Property (IPWorksEncrypt_XMLEncrypt Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getRecipientCertSerialNumber();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 52 );

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

RecipientCertSignatureAlgorithm Property (IPWorksEncrypt_XMLEncrypt Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getRecipientCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 53 );

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

RecipientCertStore Property (IPWorksEncrypt_XMLEncrypt Class)

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, 54 );
ipworksencrypt_xmlencrypt_set($res, 54, $value );

Default Value

'MY'

Remarks

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

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, 55 );
ipworksencrypt_xmlencrypt_set($res, 55, $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)

The type of certificate store for this certificate.

Object Oriented Interface

public function getRecipientCertStoreType();
public function setRecipientCertStoreType($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 56 );
ipworksencrypt_xmlencrypt_set($res, 56, $value );

Default Value

0

Remarks

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:

Data Type

Integer

RecipientCertSubjectAltNames Property (IPWorksEncrypt_XMLEncrypt Class)

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

Object Oriented Interface

public function getRecipientCertSubjectAltNames();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 57 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

RecipientCertThumbprintMD5 Property (IPWorksEncrypt_XMLEncrypt Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintMD5();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 58 );

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

RecipientCertThumbprintSHA1 Property (IPWorksEncrypt_XMLEncrypt Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 59 );

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

RecipientCertThumbprintSHA256 Property (IPWorksEncrypt_XMLEncrypt Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 60 );

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

RecipientCertUsage Property (IPWorksEncrypt_XMLEncrypt Class)

The text description of UsageFlags .

Object Oriented Interface

public function getRecipientCertUsage();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 61 );

Default Value

''

Remarks

The text description of RecipientCertUsageFlags.

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

RecipientCertUsageFlags Property (IPWorksEncrypt_XMLEncrypt Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getRecipientCertUsageFlags();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 62 );

Default Value

0

Remarks

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

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

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

This property is read-only.

Data Type

Integer

RecipientCertVersion Property (IPWorksEncrypt_XMLEncrypt Class)

The certificate's version number.

Object Oriented Interface

public function getRecipientCertVersion();

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 63 );

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

RecipientCertSubject Property (IPWorksEncrypt_XMLEncrypt Class)

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, 64 );
ipworksencrypt_xmlencrypt_set($res, 64, $value );

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

RecipientCertEncoded Property (IPWorksEncrypt_XMLEncrypt Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getRecipientCertEncoded();
public function setRecipientCertEncoded($value);

Procedural Interface

ipworksencrypt_xmlencrypt_get($res, 65 );
ipworksencrypt_xmlencrypt_set($res, 65, $value );

Default Value

''

Remarks

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

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, 66 );
ipworksencrypt_xmlencrypt_set($res, 66, $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 property is 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 property is 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 property is 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 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 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, 67 );
ipworksencrypt_xmlencrypt_set($res, 67, $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 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 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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

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

DoEvents Method (IPWorksEncrypt_XMLEncrypt Class)

This method 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 EncryptedDataDetails property 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 property is 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 property is 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
• EncryptedDataDetails
• 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

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

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

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

Base Config Settings

Trappable Errors (XMLEncrypt Class)

XMLEnc Errors

XML Errors