--- product: Chilkat product_version: 11.7.0 language: xojo language_label: Xojo class: XmlDSig license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/xojoXmlDSigRef.html --- # Chilkat XmlDSig — Xojo — v11.7.0 > Chilkat 11.7.0 · language=xojo · class=XmlDSig > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/XmlDSig.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/guide.md`. ## Purpose **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** Load an XML document containing one or more digital signatures and inspect the signature structure before verification. **Select a signature** Work with documents that contain multiple signatures by selecting the specific signature to inspect or verify. **Verify SignatureValue** Verify the cryptographic signature over the canonicalized `SignedInfo` block. **Verify Reference digests** Check individual `Reference` digest values to confirm that each signed item still matches what was originally signed. **Certificates and keys** Extract `KeyInfo`, embedded signing certificates, or public keys used to validate the signature. **Canonicalization and timestamps** Canonicalize XML for signature analysis and add an `EncapsulatedTimeStamp` when timestamping an existing signature. **Common pattern:** Load the signed XML, select the desired signature if more than one is present, inspect the signing certificate or public key information, verify the `SignatureValue`, then verify the individual reference digests. Use `XmlDSig` for verification and inspection; use `Chilkat.XmlDSigGen` when creating new XML Digital Signatures. For an extended overview, see [XmlDSig Class Overview](https://www.chilkatsoft.com/xmldsig_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```xojo Dim xmlDSig As New Chilkat.XmlDSig ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Xojo. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `ExternalRefDirs` | property, read/write | `ExternalRefDirs As String` | | `IgnoreExternalRefs` | property, read/write | `IgnoreExternalRefs As Boolean` | | `NumReferences` | property, read-only | `NumReferences As Int32 (read-only)` | | `NumSignatures` | property, read-only | `NumSignatures As Int32 (read-only)` | | `RefFailReason` | property, read-only | `RefFailReason As Int32 (read-only)` | | `Selector` | property, read/write | `Selector As Int32` | | `UncommonOptions` | property, read/write | `UncommonOptions As String` | | `AddEncapsulatedTimeStamp` | method | `Function AddEncapsulatedTimeStamp(json As Chilkat.JsonObject, sbOut As Chilkat.StringBuilder) As Boolean` | | `CanonicalizeFragment` | method | `Function CanonicalizeFragment(xml As String, fragmentId As String, version As String, prefixList As String, withComments As Boolean) As String` | | `CanonicalizeXml` | method | `Function CanonicalizeXml(xml As String, version As String, withComments As Boolean) As String` | | `GetCerts` | method | `Function GetCerts(sa As Chilkat.StringArray) As Boolean` | | `GetKeyInfo` | method | `Function GetKeyInfo() As Chilkat.Xml` | | `GetPublicKey` | method | `Function GetPublicKey() As Chilkat.PublicKey` | | `HasEncapsulatedTimeStamp` | method | `Function HasEncapsulatedTimeStamp() As Boolean` | | `IsReferenceExternal` | method | `Function IsReferenceExternal(index As Int32) As Boolean` | | `LoadSignature` | method | `Function LoadSignature(xmlSig As String) As Boolean` | | `LoadSignatureBd` | method | `Function LoadSignatureBd(binData As Chilkat.BinData) As Boolean` | | `LoadSignatureSb` | method | `Function LoadSignatureSb(sbXmlSig As Chilkat.StringBuilder) As Boolean` | | `ReferenceUri` | method | `Function ReferenceUri(index As Int32) As String` | | `SetHmacKey` | method | `Function SetHmacKey(key As String, encoding As String) As Boolean` | | `SetHttpObj` | method | `Sub SetHttpObj(http As Chilkat.Http)` | | `SetPublicKey` | method | `Function SetPublicKey(pubKey As Chilkat.PublicKey) As Boolean` | | `SetRefDataBd` | method | `Function SetRefDataBd(index As Int32, binData As Chilkat.BinData) As Boolean` | | `SetRefDataFile` | method | `Function SetRefDataFile(index As Int32, path As String) As Boolean` | | `SetRefDataSb` | method | `Function SetRefDataSb(index As Int32, sb As Chilkat.StringBuilder, charset As String) As Boolean` | | `UseCertVault` | method | `Function UseCertVault(certVault As Chilkat.XmlCertVault) As Boolean` | | `VerifyReferenceDigest` | method | `Function VerifyReferenceDigest(index As Int32) As Boolean` | | `VerifySignature` | method | `Function VerifySignature(verifyReferenceDigests As Boolean) As Boolean` | ## Properties ### XmlDSig.ExternalRefDirs `Chilkat 11.7.0 · xojo · XmlDSig · ExternalRefDirs · property · read/write · since 9.5.0.77` ```xojo ExternalRefDirs As String ``` 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. ### XmlDSig.IgnoreExternalRefs `Chilkat 11.7.0 · xojo · XmlDSig · IgnoreExternalRefs · property · read/write · since 9.5.0.77` ```xojo IgnoreExternalRefs As Boolean ``` If `True`, 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 `False`. ### XmlDSig.NumReferences `Chilkat 11.7.0 · xojo · XmlDSig · NumReferences · property · read-only · since 9.5.0.69` ```xojo NumReferences As Int32 (read-only) ``` 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. ### XmlDSig.NumSignatures `Chilkat 11.7.0 · xojo · XmlDSig · NumSignatures · property · read-only · since 9.5.0.69` ```xojo NumSignatures As Int32 (read-only) ``` The number of digital signatures found within the loaded XML. Each digital signature is composed of XML having the following structure: ``` ( ()? )+ ()? ()* ``` 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. See also: - [Online Tool to Verify XML Signature](http://tools.chilkat.io/xmlDsigVerify.cshtml) ### XmlDSig.RefFailReason `Chilkat 11.7.0 · xojo · XmlDSig · RefFailReason · property · read-only · since 9.5.0.77` ```xojo RefFailReason As Int32 (read-only) ``` 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.) ### XmlDSig.Selector `Chilkat 11.7.0 · xojo · XmlDSig · Selector · property · read/write · since 9.5.0.69` ```xojo Selector As Int32 ``` 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. ### XmlDSig.UncommonOptions `Chilkat 11.7.0 · xojo · XmlDSig · UncommonOptions · property · read/write · since 9.5.0.90` ```xojo UncommonOptions As String ``` This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty. ## Methods ### XmlDSig.AddEncapsulatedTimeStamp `Chilkat 11.7.0 · xojo · XmlDSig · AddEncapsulatedTimeStamp · method · since 9.5.0.90` ```xojo Function AddEncapsulatedTimeStamp(json As Chilkat.JsonObject, sbOut As Chilkat.StringBuilder) As Boolean ``` 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 for success, False for failure. ### XmlDSig.CanonicalizeFragment `Chilkat 11.7.0 · xojo · XmlDSig · CanonicalizeFragment · method` ```xojo Function CanonicalizeFragment(xml As String, fragmentId As String, version As String, prefixList As String, withComments As Boolean) As String ``` 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 XML - `EXCL_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 `True`, then XML comments are included in the output. If `withComments` is `False`, then XML comments are excluded from the output. Returns `Nil` on failure ### XmlDSig.CanonicalizeXml `Chilkat 11.7.0 · xojo · XmlDSig · CanonicalizeXml · method` ```xojo Function CanonicalizeXml(xml As String, version As String, withComments As Boolean) As String ``` 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 XML - `EXCL_C14N` -- for Exclusive Canonical XML If `withComments` is `True`, then XML comments are included in the output. If `withComments` is `False`, then XML comments are excluded from the output. Returns `Nil` on failure See also: - [Xml Canonicalizer Online Tool](https://tools.chilkat.io/XmlCanonicalize.cshtml) ### XmlDSig.GetCerts `Chilkat 11.7.0 · xojo · XmlDSig · GetCerts · method · since 9.5.0.76` ```xojo Function GetCerts(sa As Chilkat.StringArray) As Boolean ``` Returns the certificates found in the signature indicated by the Selector property. The base64 representation of each certificate is returned. Returns True for success, False for failure. ### XmlDSig.GetKeyInfo `Chilkat 11.7.0 · xojo · XmlDSig · GetKeyInfo · method · since 9.5.0.69` ```xojo Function GetKeyInfo() As Chilkat.Xml ``` Returns the KeyInfo XML for the signature indicated by the Selector property. Returns `Nil` if no KeyInfo exists. Returns `Nil` on failure ### XmlDSig.GetPublicKey `Chilkat 11.7.0 · xojo · XmlDSig · GetPublicKey · method · since 9.5.0.69` ```xojo Function GetPublicKey() As Chilkat.PublicKey ``` Returns the public key from the KeyInfo XML for the signature indicated by the Selector property. Returns `Nil` if no KeyInfo exists, or if no public key is actually contained in the KeyInfo. Returns `Nil` on failure ### XmlDSig.HasEncapsulatedTimeStamp `Chilkat 11.7.0 · xojo · XmlDSig · HasEncapsulatedTimeStamp · method · since 9.5.0.90` ```xojo Function HasEncapsulatedTimeStamp() As Boolean ``` Returns `True` if the signature indicated by the Selector property contains an EncapsulatedTimeStamp. Otherwise returns `False`. ### XmlDSig.IsReferenceExternal `Chilkat 11.7.0 · xojo · XmlDSig · IsReferenceExternal · method · since 9.5.0.69` ```xojo Function IsReferenceExternal(index As Int32) As Boolean ``` Returns `True` if the reference at `index` is external. Each external reference would first need to be provided by the application prior to validating the signature. ### XmlDSig.LoadSignature `Chilkat 11.7.0 · xojo · XmlDSig · LoadSignature · method · since 9.5.0.69` ```xojo Function LoadSignature(xmlSig As String) As Boolean ``` 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 for success, False for failure. ### XmlDSig.LoadSignatureBd `Chilkat 11.7.0 · xojo · XmlDSig · LoadSignatureBd · method · since 9.5.0.69` ```xojo Function LoadSignatureBd(binData As Chilkat.BinData) As Boolean ``` 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 for success, False for failure. ### XmlDSig.LoadSignatureSb `Chilkat 11.7.0 · xojo · XmlDSig · LoadSignatureSb · method · since 9.5.0.69` ```xojo Function LoadSignatureSb(sbXmlSig As Chilkat.StringBuilder) As Boolean ``` 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 for success, False for failure. ### XmlDSig.ReferenceUri `Chilkat 11.7.0 · xojo · XmlDSig · ReferenceUri · method · since 9.5.0.69` ```xojo Function ReferenceUri(index As Int32) As String ``` 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 `Nil` on failure ### XmlDSig.SetHmacKey `Chilkat 11.7.0 · xojo · XmlDSig · SetHmacKey · method · since 9.5.0.69` ```xojo Function SetHmacKey(key As String, encoding As String) As Boolean ``` **Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md) 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 for success, False for failure. ### XmlDSig.SetHttpObj `Chilkat 11.7.0 · xojo · XmlDSig · SetHttpObj · method · since 9.5.0.90` ```xojo Sub SetHttpObj(http As Chilkat.Http) ``` 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`. ### XmlDSig.SetPublicKey `Chilkat 11.7.0 · xojo · XmlDSig · SetPublicKey · method · since 9.5.0.69` ```xojo Function SetPublicKey(pubKey As Chilkat.PublicKey) As Boolean ``` 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 for success, False for failure. ### XmlDSig.SetRefDataBd `Chilkat 11.7.0 · xojo · XmlDSig · SetRefDataBd · method · since 9.5.0.69` ```xojo Function SetRefDataBd(index As Int32, binData As Chilkat.BinData) As Boolean ``` Provides the binary data for the external reference at `index`. Returns True for success, False for failure. ### XmlDSig.SetRefDataFile `Chilkat 11.7.0 · xojo · XmlDSig · SetRefDataFile · method · since 9.5.0.69` ```xojo Function SetRefDataFile(index As Int32, path As String) As Boolean ``` 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 for success, False for failure. ### XmlDSig.SetRefDataSb `Chilkat 11.7.0 · xojo · XmlDSig · SetRefDataSb · method · since 9.5.0.69` ```xojo Function SetRefDataSb(index As Int32, sb As Chilkat.StringBuilder, charset As String) As Boolean ``` 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 for success, False for failure. ### XmlDSig.UseCertVault `Chilkat 11.7.0 · xojo · XmlDSig · UseCertVault · method · since 9.5.0.69` ```xojo Function UseCertVault(certVault As Chilkat.XmlCertVault) As Boolean ``` 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 for success, False for failure. ### XmlDSig.VerifyReferenceDigest `Chilkat 11.7.0 · xojo · XmlDSig · VerifyReferenceDigest · method · since 9.5.0.69` ```xojo Function VerifyReferenceDigest(index As Int32) As Boolean ``` 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. See also: - [Online Tool to Verify XML Signature](http://tools.chilkat.io/xmlDsigVerify.cshtml) ### XmlDSig.VerifySignature `Chilkat 11.7.0 · xojo · XmlDSig · VerifySignature · method · since 9.5.0.69` ```xojo Function VerifySignature(verifyReferenceDigests As Boolean) As Boolean ``` Verifies the signature indicated by the Selector property. If `verifyReferenceDigests` is `True`, then the digest of each Reference within the signature's SignedInfo is also validated. Returns True for success, False for failure. See also: - [Online Tool to Verify XML Signature](http://tools.chilkat.io/xmlDsigVerify.cshtml) ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/BinData.md), [`Http`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/Http.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/JsonObject.md), [`PublicKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/PublicKey.md), [`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/StringArray.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/StringBuilder.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/Xml.md), [`XmlCertVault`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/XmlCertVault.md)