---
product: Chilkat
product_version: 11.7.0
language: foxpro
language_label: FoxPro
class: XmlDSig
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/foxpro_XmlDSigRef.html
---
# Chilkat XmlDSig — FoxPro — v11.7.0

> Chilkat 11.7.0 · language=foxpro · class=XmlDSig
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/XmlDSig.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/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**

```foxpro
loXmlDSig = CreateObject('Chilkat.XmlDSig')
```

Visual FoxPro is a 32-bit application and therefore uses the 32-bit Chilkat ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject('Chilkat.XmlDSig.11')` for Chilkat v11.\*.\*.

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

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. |
| `LastBinaryResult` | `LastBinaryResult As Variant (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `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 Number` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As String (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `LastStringResultLen As Number (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Number` | read/write | If set to `1`, 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 Number` |
| `NumReferences` | property, read-only | `NumReferences As Number (read-only)` |
| `NumSignatures` | property, read-only | `NumSignatures As Number (read-only)` |
| `RefFailReason` | property, read-only | `RefFailReason As Number (read-only)` |
| `Selector` | property, read/write | `Selector As Number` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `AddEncapsulatedTimeStamp` | method | `AddEncapsulatedTimeStamp(json As ChilkatJsonObject, sbOut As ChilkatStringBuilder) As Number` |
| `CanonicalizeFragment` | method | `CanonicalizeFragment(xml As String, fragmentId As String, version As String, prefixList As String, withComments As Number) As String` |
| `CanonicalizeXml` | method | `CanonicalizeXml(xml As String, version As String, withComments As Number) As String` |
| `GetCerts` | method | `GetCerts(sa As CkStringArray) As Number` |
| `GetKeyInfo` | method | `GetKeyInfo() As ChilkatXml` |
| `GetPublicKey` | method | `GetPublicKey() As PublicKey` |
| `HasEncapsulatedTimeStamp` | method | `HasEncapsulatedTimeStamp() As Number` |
| `IsReferenceExternal` | method | `IsReferenceExternal(index As Number) As Number` |
| `LoadSignature` | method | `LoadSignature(xmlSig As String) As Number` |
| `LoadSignatureBd` | method | `LoadSignatureBd(binData As ChilkatBinData) As Number` |
| `LoadSignatureSb` | method | `LoadSignatureSb(sbXmlSig As ChilkatStringBuilder) As Number` |
| `ReferenceUri` | method | `ReferenceUri(index As Number) As String` |
| `SetHmacKey` | method | `SetHmacKey(key As String, encoding As String) As Number` |
| `SetHttpObj` | method | `SetHttpObj(http As ChilkatHttp)` |
| `SetPublicKey` | method | `SetPublicKey(pubKey As PublicKey) As Number` |
| `SetRefDataBd` | method | `SetRefDataBd(index As Number, binData As ChilkatBinData) As Number` |
| `SetRefDataFile` | method | `SetRefDataFile(index As Number, path As String) As Number` |
| `SetRefDataSb` | method | `SetRefDataSb(index As Number, sb As ChilkatStringBuilder, charset As String) As Number` |
| `UseCertVault` | method | `UseCertVault(certVault As ChilkatXmlCertVault) As Number` |
| `VerifyReferenceDigest` | method | `VerifyReferenceDigest(index As Number) As Number` |
| `VerifySignature` | method | `VerifySignature(verifyReferenceDigests As Number) As Number` |

## Properties

### XmlDSig.ExternalRefDirs

`Chilkat 11.7.0 · foxpro · XmlDSig · ExternalRefDirs · property · read/write · since 9.5.0.77`

```foxpro
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 · foxpro · XmlDSig · IgnoreExternalRefs · property · read/write · since 9.5.0.77`

```foxpro
IgnoreExternalRefs As Number
```

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

### XmlDSig.NumReferences

`Chilkat 11.7.0 · foxpro · XmlDSig · NumReferences · property · read-only · since 9.5.0.69`

```foxpro
NumReferences As Number (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 · foxpro · XmlDSig · NumSignatures · property · read-only · since 9.5.0.69`

```foxpro
NumSignatures As Number (read-only)
```

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.

See also:

- [Online Tool to Verify XML Signature](http://tools.chilkat.io/xmlDsigVerify.cshtml)

### XmlDSig.RefFailReason

`Chilkat 11.7.0 · foxpro · XmlDSig · RefFailReason · property · read-only · since 9.5.0.77`

```foxpro
RefFailReason As Number (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 · foxpro · XmlDSig · Selector · property · read/write · since 9.5.0.69`

```foxpro
Selector As Number
```

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 · foxpro · XmlDSig · UncommonOptions · property · read/write · since 9.5.0.90`

```foxpro
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 · foxpro · XmlDSig · AddEncapsulatedTimeStamp · method · since 9.5.0.90`

```foxpro
AddEncapsulatedTimeStamp(json As ChilkatJsonObject, sbOut As ChilkatStringBuilder) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.CanonicalizeFragment

`Chilkat 11.7.0 · foxpro · XmlDSig · CanonicalizeFragment · method`

```foxpro
CanonicalizeFragment(xml As String, fragmentId As String, version As String, prefixList As String, withComments As Number) 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 `1`, then XML comments are included in the output. If `withComments` is `0`, then XML comments are excluded from the output.

Returns `.NULL.` on failure

### XmlDSig.CanonicalizeXml

`Chilkat 11.7.0 · foxpro · XmlDSig · CanonicalizeXml · method`

```foxpro
CanonicalizeXml(xml As String, version As String, withComments As Number) 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 `1`, then XML comments are included in the output. If `withComments` is `0`, then XML comments are excluded from the output.

Returns `.NULL.` on failure

See also:

- [Xml Canonicalizer Online Tool](https://tools.chilkat.io/XmlCanonicalize.cshtml)

### XmlDSig.GetCerts

`Chilkat 11.7.0 · foxpro · XmlDSig · GetCerts · method · since 9.5.0.76`

```foxpro
GetCerts(sa As CkStringArray) As Number
```

Returns the certificates found in the signature indicated by the Selector property. The base64 representation of each certificate is returned.

Returns 1 for success, 0 for failure.

### XmlDSig.GetKeyInfo

`Chilkat 11.7.0 · foxpro · XmlDSig · GetKeyInfo · method · since 9.5.0.69`

```foxpro
GetKeyInfo() As ChilkatXml
```

Returns the KeyInfo XML for the signature indicated by the Selector property. Returns `.NULL.` if no KeyInfo exists.

Returns `.NULL.` on failure

### XmlDSig.GetPublicKey

`Chilkat 11.7.0 · foxpro · XmlDSig · GetPublicKey · method · since 9.5.0.69`

```foxpro
GetPublicKey() As PublicKey
```

Returns the public key from the KeyInfo XML for the signature indicated by the Selector property. Returns `.NULL.` if no KeyInfo exists, or if no public key is actually contained in the KeyInfo.

Returns `.NULL.` on failure

### XmlDSig.HasEncapsulatedTimeStamp

`Chilkat 11.7.0 · foxpro · XmlDSig · HasEncapsulatedTimeStamp · method · since 9.5.0.90`

```foxpro
HasEncapsulatedTimeStamp() As Number
```

Returns `1` if the signature indicated by the Selector property contains an EncapsulatedTimeStamp. Otherwise returns `0`.

### XmlDSig.IsReferenceExternal

`Chilkat 11.7.0 · foxpro · XmlDSig · IsReferenceExternal · method · since 9.5.0.69`

```foxpro
IsReferenceExternal(index As Number) As Number
```

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.

### XmlDSig.LoadSignature

`Chilkat 11.7.0 · foxpro · XmlDSig · LoadSignature · method · since 9.5.0.69`

```foxpro
LoadSignature(xmlSig As String) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.LoadSignatureBd

`Chilkat 11.7.0 · foxpro · XmlDSig · LoadSignatureBd · method · since 9.5.0.69`

```foxpro
LoadSignatureBd(binData As ChilkatBinData) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.LoadSignatureSb

`Chilkat 11.7.0 · foxpro · XmlDSig · LoadSignatureSb · method · since 9.5.0.69`

```foxpro
LoadSignatureSb(sbXmlSig As ChilkatStringBuilder) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.ReferenceUri

`Chilkat 11.7.0 · foxpro · XmlDSig · ReferenceUri · method · since 9.5.0.69`

```foxpro
ReferenceUri(index As Number) 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 `.NULL.` on failure

### XmlDSig.SetHmacKey

`Chilkat 11.7.0 · foxpro · XmlDSig · SetHmacKey · method · since 9.5.0.69`

```foxpro
SetHmacKey(key As String, encoding As String) As Number
```

**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 1 for success, 0 for failure.

### XmlDSig.SetHttpObj

`Chilkat 11.7.0 · foxpro · XmlDSig · SetHttpObj · method · since 9.5.0.90`

```foxpro
SetHttpObj(http As ChilkatHttp)
```

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 · foxpro · XmlDSig · SetPublicKey · method · since 9.5.0.69`

```foxpro
SetPublicKey(pubKey As PublicKey) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.SetRefDataBd

`Chilkat 11.7.0 · foxpro · XmlDSig · SetRefDataBd · method · since 9.5.0.69`

```foxpro
SetRefDataBd(index As Number, binData As ChilkatBinData) As Number
```

Provides the binary data for the external reference at `index`.

Returns 1 for success, 0 for failure.

### XmlDSig.SetRefDataFile

`Chilkat 11.7.0 · foxpro · XmlDSig · SetRefDataFile · method · since 9.5.0.69`

```foxpro
SetRefDataFile(index As Number, path As String) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.SetRefDataSb

`Chilkat 11.7.0 · foxpro · XmlDSig · SetRefDataSb · method · since 9.5.0.69`

```foxpro
SetRefDataSb(index As Number, sb As ChilkatStringBuilder, charset As String) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.UseCertVault

`Chilkat 11.7.0 · foxpro · XmlDSig · UseCertVault · method · since 9.5.0.69`

```foxpro
UseCertVault(certVault As ChilkatXmlCertVault) As Number
```

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 1 for success, 0 for failure.

### XmlDSig.VerifyReferenceDigest

`Chilkat 11.7.0 · foxpro · XmlDSig · VerifyReferenceDigest · method · since 9.5.0.69`

```foxpro
VerifyReferenceDigest(index As Number) As Number
```

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 · foxpro · XmlDSig · VerifySignature · method · since 9.5.0.69`

```foxpro
VerifySignature(verifyReferenceDigests As Number) As Number
```

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 1 for success, 0 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/foxpro/classes/BinData.md), [`Http`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Http.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/JsonObject.md), [`PublicKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/PublicKey.md), [`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/StringArray.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/StringBuilder.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Xml.md), [`XmlCertVault`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/XmlCertVault.md)

