XmlDSig Chilkat2 Perl Reference Documentation
Chilkat2::XmlDSig
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.XmlDSig
Load an XML document containing one or more digital signatures and
inspect the signature structure before verification.
Work with documents that contain multiple signatures by selecting the
specific signature to inspect or verify.
Verify the cryptographic signature over the canonicalized
Check individual
Extract
Canonicalize XML for signature analysis and add an
For an extended overview, see
XmlDSig Class Overview.
Load, inspect, canonicalize, and verify XML Digital Signatures.
Chilkat.XmlDSig loads and verifies XML Digital Signatures. It
can inspect signed XML, select among multiple signatures in one document,
verify the overall SignatureValue, verify individual
Reference digests, handle external references, extract
KeyInfo, retrieve embedded certificates or public keys,
canonicalize XML, and add an EncapsulatedTimeStamp to an
existing signature.
Load signed XML
Select a signature
Verify SignatureValue
SignedInfo block.
Verify Reference digests
Reference digest values to confirm that
each signed item still matches what was originally signed.
Certificates and keys
KeyInfo, embedded signing certificates, or public
keys used to validate the signature.
Canonicalization and timestamps
EncapsulatedTimeStamp when timestamping an existing
signature.
SignatureValue, then verify the individual reference
digests. Use XmlDSig for verification and inspection; use
Chilkat.XmlDSigGen when creating new XML Digital Signatures.
Object Creation
use Chilkat2;
my $xmlDSig = Chilkat2::XmlDSig->new;
# or set properties (and RaiseError) at creation:
# my $xmlDSig = Chilkat2::XmlDSig->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/XmlDSig.pm file holds only this class's documentation (perldoc Chilkat2::XmlDSig).
Perl frees the object when its last reference goes (undef $xmlDSig, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::XmlDSig';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::XmlDSig'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
my $strVal = $xmlDSig->DebugLogFilePath;
$xmlDSig->DebugLogFilePath($strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
ExternalRefDirs
my $strVal = $xmlDSig->ExternalRefDirs;
$xmlDSig->ExternalRefDirs($strVal);
May contain a set of directory paths specifying where referenced external files are located. Directory paths should be separated using a semicolon character. The default value of this property is the empty string which means no directories are automatically searched.
This property can be used if the external file referenced in the XML signature has the same filename as the file in the local filesystem.
IgnoreExternalRefs
my $boolVal = $xmlDSig->IgnoreExternalRefs;
$xmlDSig->IgnoreExternalRefs($boolVal);
If 1, then ignore failures caused by external references not being available. This allows for the XML signature to be at least partially validated if the external referenced files are not available. The default value of this property is 0.
LastErrorHtml
my $strVal = $xmlDSig->LastErrorHtml;
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
my $strVal = $xmlDSig->LastErrorText;
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
my $strVal = $xmlDSig->LastErrorXml;
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
my $boolVal = $xmlDSig->LastMethodSuccess;
$xmlDSig->LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumReferences
my $intVal = $xmlDSig->NumReferences;
The number of data objects referenced in the XML digital signature. A data object may be self-contained within the loaded XML signature, or it may be an external URI reference. An application can check each reference to see if it's external by calling IsReferenceExternal, and can get each reference URI by calling ReferenceUri.
NumSignatures
my $intVal = $xmlDSig->NumSignatures;
The number of digital signatures found within the loaded XML. Each digital signature is composed of XML having the following structure:
<Signature ID?>
<SignedInfo>
<CanonicalizationMethod/>
<SignatureMethod/>
(<Reference URI? >
(<Transforms>)?
<DigestMethod>
<DigestValue>
</Reference>)+
</SignedInfo>
<SignatureValue>
(<KeyInfo>)?
(<Object ID?>)*
</Signature>
Note: The Signature and other XML tags may be namespace prefixed.
The Selector property is used to select which XML signature is in effect when validating or calling other methods or properties.
RefFailReason
my $intVal = $xmlDSig->RefFailReason;
Indicates the failure reason for the last call to VerifyReferenceDigest. Possible values are:
- 0: No failure, the reference digest was valid.
- 1: The computed digest differs from the digest stored in the XML.
- 2: An external file is referenced, but it is unavailable for computing the digest.
- 3: The index argument passed to VerifyReferenceDigest was out of range.
- 4: Unable to find the Signature.
- 5: A transformation specified some sort of XML canonicalization that is not supported.
- 99: Unknown. (Should never get this value.)
Selector
my $intVal = $xmlDSig->Selector;
$xmlDSig->Selector($intVal);
If the loaded XML contains multiple signatures, this property can be set to specify which signature is in effect when calling other methods or properties. In most cases, the loaded XML contains a single signature and this property will remain at the default value of 0.
UncommonOptions
my $strVal = $xmlDSig->UncommonOptions;
$xmlDSig->UncommonOptions($strVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.
topVerboseLogging
my $boolVal = $xmlDSig->VerboseLogging;
$xmlDSig->VerboseLogging($boolVal);
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
my $strVal = $xmlDSig->Version;
Methods
AddEncapsulatedTimeStamp
# $sbOut is a Chilkat2::StringBuilder
# $success is true or false
my $success = $xmlDSig->AddEncapsulatedTimeStamp($json, $sbOut);
Adds an EncapsulatedTimeStamp to the signature indicated by the Selector property. The updated signed XML with the added EncapsulatedTimeStamp is returned in $sbOut. See the example below for details.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
CanonicalizeFragment
# $fragmentId is a string
# $version is a string
# $prefixList is a string
# $withComments is a boolean
# $str is a string or undef
my $str = $xmlDSig->CanonicalizeFragment($xml, $fragmentId, $version, $prefixList, $withComments);
Applies XML canonicalization to a fragment of the passed-in XML, and returns the canonicalized XML string. The $fragmentId identifies the XML element where output begins. It is the XML element having an id attribute equal to $fragmentId. The $version may be one of the following:
C14N-- for Inclusive Canonical XMLEXCL_C14N-- for Exclusive Canonical XML
The $prefixList only applies when the $version is set to EXCL_C14N. The $prefixList may be an empty string, or a SPACE separated list of namespace prefixes. It is the InclusiveNamespaces PrefixList, which is the list of namespaces that are propagated from ancestor elements for canonicalization purposes.
If $withComments is 1, then XML comments are included in the output. If $withComments is 0, then XML comments are excluded from the output.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
CanonicalizeXml
# $version is a string
# $withComments is a boolean
# $str is a string or undef
my $str = $xmlDSig->CanonicalizeXml($xml, $version, $withComments);
Applies XML canonicalization to the passed-in XML, and returns the canonicalized XML string. The $version may be one of the following:
C14N-- for Inclusive Canonical XMLEXCL_C14N-- for Exclusive Canonical XML
If $withComments is 1, then XML comments are included in the output. If $withComments is 0, then XML comments are excluded from the output.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetCerts
Returns the certificates found in the signature indicated by the Selector property. The base64 representation of each certificate is returned.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetKeyInfo
Returns the KeyInfo XML for the signature indicated by the Selector property. Returns undef if no KeyInfo exists.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way. The returned object is new and independent of this one, and inherits its RaiseError.
GetPublicKey
Returns the public key from the KeyInfo XML for the signature indicated by the Selector property. Returns undef if no KeyInfo exists, or if no public key is actually contained in the KeyInfo.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way. The returned object is new and independent of this one, and inherits its RaiseError.
HasEncapsulatedTimeStamp
my $flag = $xmlDSig->HasEncapsulatedTimeStamp();
Returns 1 if the signature indicated by the Selector property contains an EncapsulatedTimeStamp. Otherwise returns 0.
Never dies: false is an answer, not a failure.
IsReferenceExternal
# $flag is true or false
my $flag = $xmlDSig->IsReferenceExternal($index);
Returns 1 if the reference at $index is external. Each external reference would first need to be provided by the application prior to validating the signature.
Never dies: false is an answer, not a failure.
LoadSignature
# $success is true or false
my $success = $xmlDSig->LoadSignature($xmlSig);
Loads an XML document containing 1 or more XML digital signatures. An application would first load XML containing digital signature(s), then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.
Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadSignatureBd
# $success is true or false
my $success = $xmlDSig->LoadSignatureBd($binData);
Loads an XML document containing one or more XML digital signatures from the contents of a BinData object. An application would first load the XML, then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.
Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadSignatureSb
# $success is true or false
my $success = $xmlDSig->LoadSignatureSb($sbXmlSig);
Loads an XML document containing one or more XML digital signatures from the contents of a StringBuilder object. An application would first load the XML, then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.
Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ReferenceUri
# $str is a string or undef
my $str = $xmlDSig->ReferenceUri($index);
Returns the URI of the Nth reference specified by $index. (The 1st reference is at index 0.) URI's beginning with a pound sign ('#') are internal references.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetHmacKey
# $encoding is a string
# $success is true or false
my $success = $xmlDSig->SetHmacKey($key, $encoding);
Sets the HMAC key to be used if the Signature used an HMAC signing algorithm. The $encoding specifies the encoding of $key, and can be hex, base64, ascii, or any of the binary encodings supported by Chilkat in the link below.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetHttpObj
Sets the HTTP object to be used to communicate with OCSP responders, CRL distribution points, or timestamp authority (TSA) servers if needed. The $http is used to send the requests, and it allows for connection related settings and timeouts to be set. For example, if HTTP or SOCKS proxies are required, these features can be specified on the $http.
Returns the object, so calls can be chained.
topSetPublicKey
# $success is true or false
my $success = $xmlDSig->SetPublicKey($pubKey);
Sets the public key to be used for verifying the signature indicated by the Selector property. A public key only needs to be explicitly provided by the application for those XML signatures where the public key is not already available within the KeyInfo of the Signature. In some cases, the KeyInfo within the Signature contains information about what public key was used for signing. The application can use this information to retrieve the matching public key and provide it via this method.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetRefDataBd
# $binData is a Chilkat2::BinData
# $success is true or false
my $success = $xmlDSig->SetRefDataBd($index, $binData);
Provides the binary data for the external reference at $index.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetRefDataFile
# $path is a string
# $success is true or false
my $success = $xmlDSig->SetRefDataFile($index, $path);
Provides the data for the external reference at $index. When validating the signature, the data contained in $path will be streamed to compute the digest for validation.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetRefDataSb
# $sb is a Chilkat2::StringBuilder
# $charset is a string
# $success is true or false
my $success = $xmlDSig->SetRefDataSb($index, $sb, $charset);
Provides the text data for the external reference at $index. The $charset specifies the byte representation of the text, such as utf-8, utf-16, windows-1252, etc. (If in doubt, try utf-8 first.)
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
UseCertVault
# $success is true or false
my $success = $xmlDSig->UseCertVault($certVault);
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates having public keys when verifying an XML signature. A single XML certificate vault may be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
VerifyReferenceDigest
# $flag is true or false
my $flag = $xmlDSig->VerifyReferenceDigest($index);
This method allows for an application to verify the digest for each reference separately. This can be helpful if the full XMLDSIG validation fails, then one can test each referenced data's digest to see which, if any, fail to match.
Never dies: false is an answer, not a failure.
VerifySignature
# $success is true or false
my $success = $xmlDSig->VerifySignature($verifyReferenceDigests);
Verifies the signature indicated by the Selector property. If $verifyReferenceDigests is 1, then the digest of each Reference within the signature's SignedInfo is also validated.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.