XMLSig Class

Properties   Methods   Events   Config Settings   Errors  

The XMLSig class is used to sign XML and verify signed XML.

Class Name

IPWorksEncrypt_XMLSig

Procedural Interface

 ipworksencrypt_xmlsig_open();
 ipworksencrypt_xmlsig_close($res);
 ipworksencrypt_xmlsig_register_callback($res, $id, $function);
 ipworksencrypt_xmlsig_get_last_error($res);
 ipworksencrypt_xmlsig_get_last_error_code($res);
 ipworksencrypt_xmlsig_set($res, $id, $index, $value);
 ipworksencrypt_xmlsig_get($res, $id, $index);
 ipworksencrypt_xmlsig_do_config($res, $configurationstring);
 ipworksencrypt_xmlsig_do_doevents($res);
 ipworksencrypt_xmlsig_do_reset($res);
 ipworksencrypt_xmlsig_do_sign($res);
 ipworksencrypt_xmlsig_do_verifysignature($res);

Remarks

The XMLSig component provides an easy to use API for signing and verifying signed XML. The Sign method will create signed XML with an enveloped signature. The VerifySignature method will attempt to verify the signature(s) within a XML document.

Sign

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The References property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set Certificate to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call Sign to sign the XML.

The following properties are applicable when calling this method:

• CanonicalizationMethod
• Certificate (required)
• References (required)
• SignatureXPath
• SigningAlgorithm

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.

Verify a Signature

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

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.

CanonicalizationMethod Property (IPWorksEncrypt_XMLSig Class)

The canonicalization method applied to the signature.

Object Oriented Interface

public function getCanonicalizationMethod();
public function setCanonicalizationMethod($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 1 );
ipworksencrypt_xmlsig_set($res, 1, $value );

Default Value

0

Remarks

This property specifies the canonicalization method that is applied to the signature. This may be set before calling Sign. This will be set automatically after calling VerifySignature. Possible values are:

This property is not available at design time.

Data Type

Integer

CertEffectiveDate Property (IPWorksEncrypt_XMLSig Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getCertEffectiveDate();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 2 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getCertExpirationDate();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 3 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 4 );

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

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

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 5 );

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

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

Object Oriented Interface

public function getCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 6 );

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

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

Object Oriented Interface

public function getCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 7 );

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

The issuer of the certificate.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 8 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getCertPrivateKey();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 9 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 10 );

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

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

Object Oriented Interface

public function getCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 11 );

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

The public key of the certificate.

Object Oriented Interface

public function getCertPublicKey();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 12 );

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

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

Object Oriented Interface

public function getCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 13 );

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

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

Object Oriented Interface

public function getCertPublicKeyLength();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 14 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getCertSerialNumber();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 15 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 16 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getCertStore();
public function setCertStore($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 17 );
ipworksencrypt_xmlsig_set($res, 17, $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_XMLSig 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_xmlsig_get($res, 18 );
ipworksencrypt_xmlsig_set($res, 18, $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_XMLSig Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksencrypt_xmlsig_get($res, 19 );
ipworksencrypt_xmlsig_set($res, 19, $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_XMLSig Class)

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

Object Oriented Interface

public function getCertSubjectAltNames();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 20 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (IPWorksEncrypt_XMLSig Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintMD5();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 21 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 22 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 23 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getCertUsage();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 24 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getCertUsageFlags();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 25 );

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

The certificate's version number.

Object Oriented Interface

public function getCertVersion();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 26 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getCertSubject();
public function setCertSubject($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 27 );
ipworksencrypt_xmlsig_set($res, 27, $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_XMLSig Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksencrypt_xmlsig_get($res, 28 );
ipworksencrypt_xmlsig_set($res, 28, $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

HMACKey Property (IPWorksEncrypt_XMLSig Class)

The HMAC key used with the 'HMAC-SHA1' signing algorithm.

Object Oriented Interface

public function getHMACKey();
public function setHMACKey($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 29 );
ipworksencrypt_xmlsig_set($res, 29, $value );

Default Value

''

Remarks

This property defines the HMAC key to be used when SigningAlgorithm is set to "HMAC-SHA1". This must be set before calling before calling Sign.

This property is also applicable when calling VerifySignature. This may be set before calling VerifySignature or from within the SignatureInfo event.

This property is not available at design time.

Data Type

Binary String

InputFile Property (IPWorksEncrypt_XMLSig Class)

The XML file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 30 );
ipworksencrypt_xmlsig_set($res, 30, $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_XMLSig Class)

The XML to process.

Object Oriented Interface

public function getInputXML();
public function setInputXML($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 31 );
ipworksencrypt_xmlsig_set($res, 31, $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_XMLSig Class)

The output file.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 32 );
ipworksencrypt_xmlsig_set($res, 32, $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_XMLSig Class)

The output XML after processing.

Object Oriented Interface

public function getOutputXML();
public function setOutputXML($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 33 );
ipworksencrypt_xmlsig_set($res, 33, $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_XMLSig Class)

Indicates whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 34 );
ipworksencrypt_xmlsig_set($res, 34, $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

ReferenceCount Property (IPWorksEncrypt_XMLSig Class)

The number of records in the Reference arrays.

Object Oriented Interface

public function getReferenceCount();
public function setReferenceCount($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 35 );
ipworksencrypt_xmlsig_set($res, 35, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceHashAlgorithm
• ReferenceHashValue
• ReferenceTransformAlgorithms
• ReferenceURI
• ReferenceXMLElement

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

This property is not available at design time.

Data Type

Integer

ReferenceHashAlgorithm Property (IPWorksEncrypt_XMLSig Class)

This property defines the hash algorithm to apply to the element specified by XMLElement .

Object Oriented Interface

public function getReferenceHashAlgorithm($referenceindex);
public function setReferenceHashAlgorithm($referenceindex, $value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 36 , $referenceindex);
ipworksencrypt_xmlsig_set($res, 36, $value , $referenceindex);

Default Value

'SHA1'

Remarks

This property defines the hash algorithm to apply to the element specified by ReferenceXMLElement. Possible values are:

• "SHA1" (default)
• "SHA256"
• "SHA512"

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceHashValue Property (IPWorksEncrypt_XMLSig Class)

This property holds the calculated hash value for the specified XMLElement .

Object Oriented Interface

public function getReferenceHashValue($referenceindex);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 37 , $referenceindex);

Default Value

''

Remarks

This property holds the calculated hash value for the specified ReferenceXMLElement.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceTransformAlgorithms Property (IPWorksEncrypt_XMLSig Class)

This property specifies a comma separated list of canonicalization algorithms to be applied to XMLElement .

Object Oriented Interface

public function getReferenceTransformAlgorithms($referenceindex);
public function setReferenceTransformAlgorithms($referenceindex, $value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 38 , $referenceindex);
ipworksencrypt_xmlsig_set($res, 38, $value , $referenceindex);

Default Value

'C14N'

Remarks

This property specifies a comma separated list of canonicalization algorithms to be applied to ReferenceXMLElement. The XML data specified by ReferenceXMLElement will be transformed using the specified algorithm(s) before the HashAlgorithm is applied. The default value is "C14N". Possible values are:

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceURI Property (IPWorksEncrypt_XMLSig Class)

This property is the URI of the reference.

Object Oriented Interface

public function getReferenceURI($referenceindex);
public function setReferenceURI($referenceindex, $value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 39 , $referenceindex);
ipworksencrypt_xmlsig_set($res, 39, $value , $referenceindex);

Default Value

''

Remarks

This property is the URI of the reference. The value specified here identifies the data within the document.

When signing, this value may be set to a URI reference which identifies ReferenceXMLElement. ReferenceXMLElement must be set separately.

When verifying, this value may be checked within the SignatureInfo event to identify the location of ReferenceXMLElement. ReferenceXMLElement must be set separately.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXMLElement Property (IPWorksEncrypt_XMLSig Class)

This property specifies XML element to sign or verify using XPath notation.

Object Oriented Interface

public function getReferenceXMLElement($referenceindex);
public function setReferenceXMLElement($referenceindex, $value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 40 , $referenceindex);
ipworksencrypt_xmlsig_set($res, 40, $value , $referenceindex);

Default Value

'/'

Remarks

This property specifies XML element to sign or verify using XPath notation. When signing, this must be set before calling Sign. When verifying, this must be set from within the SignatureInfo event. The ReferenceURI property may be used to help identify the correct XML element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

SignatureXPath Property (IPWorksEncrypt_XMLSig Class)

The XPath of the signature.

Object Oriented Interface

public function getSignatureXPath();
public function setSignatureXPath($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 41 );
ipworksencrypt_xmlsig_set($res, 41, $value );

Default Value

'/'

Remarks

This property specifies the XPath in the XML where the signature will be placed.

This may be set before calling Sign. This property will be populated when calling VerifySignature.

The default value is "/".

This property is not available at design time.

Data Type

String

SignerCertEffectiveDate Property (IPWorksEncrypt_XMLSig Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSignerCertEffectiveDate();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 42 );

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

SignerCertExpirationDate Property (IPWorksEncrypt_XMLSig Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSignerCertExpirationDate();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 43 );

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

SignerCertExtendedKeyUsage Property (IPWorksEncrypt_XMLSig Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSignerCertExtendedKeyUsage();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 44 );

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

SignerCertFingerprint Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertFingerprint();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 45 );

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

SignerCertFingerprintSHA1 Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertFingerprintSHA1();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 46 );

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

SignerCertFingerprintSHA256 Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertFingerprintSHA256();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 47 );

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

SignerCertIssuer Property (IPWorksEncrypt_XMLSig Class)

The issuer of the certificate.

Object Oriented Interface

public function getSignerCertIssuer();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 48 );

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

SignerCertPrivateKey Property (IPWorksEncrypt_XMLSig Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKey();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 49 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SignerCertPrivateKeyAvailable Property (IPWorksEncrypt_XMLSig Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSignerCertPrivateKeyAvailable();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 50 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SignerCertPrivateKeyContainer Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertPrivateKeyContainer();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 51 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SignerCertPublicKey Property (IPWorksEncrypt_XMLSig Class)

The public key of the certificate.

Object Oriented Interface

public function getSignerCertPublicKey();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 52 );

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

SignerCertPublicKeyAlgorithm Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertPublicKeyAlgorithm();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 53 );

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

SignerCertPublicKeyLength Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertPublicKeyLength();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 54 );

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

SignerCertSerialNumber Property (IPWorksEncrypt_XMLSig Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSignerCertSerialNumber();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 55 );

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

SignerCertSignatureAlgorithm Property (IPWorksEncrypt_XMLSig Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSignerCertSignatureAlgorithm();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 56 );

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

SignerCertStore Property (IPWorksEncrypt_XMLSig Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSignerCertStore();
public function setSignerCertStore($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 57 );
ipworksencrypt_xmlsig_set($res, 57, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.

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

SignerCertStorePassword Property (IPWorksEncrypt_XMLSig 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 getSignerCertStorePassword();
public function setSignerCertStorePassword($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 58 );
ipworksencrypt_xmlsig_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

SignerCertStoreType Property (IPWorksEncrypt_XMLSig Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSignerCertStoreType();
public function setSignerCertStoreType($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 59 );
ipworksencrypt_xmlsig_set($res, 59, $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

SignerCertSubjectAltNames Property (IPWorksEncrypt_XMLSig Class)

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

Object Oriented Interface

public function getSignerCertSubjectAltNames();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 60 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SignerCertThumbprintMD5 Property (IPWorksEncrypt_XMLSig Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintMD5();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 61 );

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

SignerCertThumbprintSHA1 Property (IPWorksEncrypt_XMLSig Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA1();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 62 );

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

SignerCertThumbprintSHA256 Property (IPWorksEncrypt_XMLSig Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA256();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 63 );

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

SignerCertUsage Property (IPWorksEncrypt_XMLSig Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSignerCertUsage();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 64 );

Default Value

''

Remarks

The text description of SignerCertUsageFlags.

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

SignerCertUsageFlags Property (IPWorksEncrypt_XMLSig Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSignerCertUsageFlags();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 65 );

Default Value

0

Remarks

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

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SignerCertVersion Property (IPWorksEncrypt_XMLSig Class)

The certificate's version number.

Object Oriented Interface

public function getSignerCertVersion();

Procedural Interface

ipworksencrypt_xmlsig_get($res, 66 );

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

SignerCertSubject Property (IPWorksEncrypt_XMLSig Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSignerCertSubject();
public function setSignerCertSubject($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 67 );
ipworksencrypt_xmlsig_set($res, 67, $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

SignerCertEncoded Property (IPWorksEncrypt_XMLSig Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded();
public function setSignerCertEncoded($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 68 );
ipworksencrypt_xmlsig_set($res, 68, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SigningAlgorithm Property (IPWorksEncrypt_XMLSig Class)

The signing algorithm.

Object Oriented Interface

public function getSigningAlgorithm();
public function setSigningAlgorithm($value);

Procedural Interface

ipworksencrypt_xmlsig_get($res, 69 );
ipworksencrypt_xmlsig_set($res, 69, $value );

Default Value

''

Remarks

This property specifies the signing algorithm.

This may be set before calling Sign. This value will be set after calling VerifySignature. Possible values are:

• "RSA-SHA1" (default)
• "RSA-SHA256"
• "DSA-SHA1"
• "HMAC-SHA1"

This property is not available at design time.

Data Type

String

Config Method (IPWorksEncrypt_XMLSig Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoEvents Method (IPWorksEncrypt_XMLSig Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Reset Method (IPWorksEncrypt_XMLSig Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_xmlsig_do_reset($res);

Remarks

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

Sign Method (IPWorksEncrypt_XMLSig Class)

Signs the XML.

Object Oriented Interface

public function doSign();

Procedural Interface

ipworksencrypt_xmlsig_do_sign($res);

Remarks

This methods signs the XML.

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The References property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set Certificate to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call Sign to sign the XML.

The following properties are applicable when calling this method:

• CanonicalizationMethod
• Certificate (required)
• References (required)
• SignatureXPath
• SigningAlgorithm

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.

VerifySignature Method (IPWorksEncrypt_XMLSig Class)

Verifies signed XML.

Object Oriented Interface

public function doVerifySignature();

Procedural Interface

ipworksencrypt_xmlsig_do_verifysignature($res);

Remarks

This method verifies signatures contained in the XML.

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

Error Event (IPWorksEncrypt_XMLSig Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_xmlsig_register_callback($res, 1, 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_XMLSig Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_xmlsig_register_callback($res, 2, 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.

SignatureInfo Event (IPWorksEncrypt_XMLSig Class)

Fired when a signature is found.

Object Oriented Interface

public function fireSignatureInfo($param);

Procedural Interface

ipworksencrypt_xmlsig_register_callback($res, 3, array($this, 'fireSignatureInfo'));

Parameter List

 'signatureid'
 'signercertparsed'

Remarks

This event fires when calling VerifySignature for each signature found within the XML document.

SignatureId is the id of the signature.

SignerCertParsed indicates whether the signer's certificate was automatically parsed from the signed XML.

Verification Notes

When VerifySignature is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the References collection will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error.

Status Event (IPWorksEncrypt_XMLSig Class)

Provides information about the current operation.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworksencrypt_xmlsig_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 (XMLSig Class)

XMLSig Config Settings

<root>
  <node1>
    <ds:Signature>...</ds:Signature>
  </node1>
  <node2></node2>
  <node3></node3>
</root>

<root>
  <node1></node1>
  <ds:Signature>...</ds:Signature>
  <node2></node2>
  <node3></node3>
</root>

Base Config Settings

Trappable Errors (XMLSig Class)

XMLSig Errors

XML Errors