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

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

## Purpose

**Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.**

`Chilkat.XmlCertVault` stores certificates and private-key material in a portable XML-based certificate vault. It can add individual certificates, certificate chains, DER or encoded certificates, PEM files, certificate strings, and PFX/PKCS12 data from files, memory, encoded text, or existing Chilkat objects. The vault can then be exported as XML, loaded from XML, or saved to an XML file for later reuse by other Chilkat certificate and TLS workflows.

**Add certificates**

Add certificates from `Cert` objects, files, PEM strings, binary DER bytes, or encoded data such as Base64 or hex.

**Add certificate chains**

Import an entire `CertChain` when related issuer and intermediate certificates should be kept together in the vault.

**Add PEM content**

Load PEM files containing one or more certificates and/or private keys, including encrypted PEM content when a password is supplied.

**Add PFX / PKCS12**

Add PFX data from a `Pfx` object, file, byte array, or encoded string, using the PFX password to import private-key material.

**Master password protection**

Use `MasterPassword` to protect access to private keys stored in the vault.

**Load and save XML**

Export the vault with `GetXml`, load it with `LoadXml` or `LoadXmlFile`, and persist it with `SaveXml`.

**Common pattern:** Create an `XmlCertVault`, set `MasterPassword` when the vault will contain private keys, add certificates or PFX/PEM material, then save the vault with `SaveXml` or keep the XML string from `GetXml`. Later, reload the same vault with `LoadXml` or `LoadXmlFile` and provide the same master password before using private keys.

**Security note:** Certificates are stored unencrypted, but private keys are stored using 256-bit AES encryption. The individual PFX passwords are also stored encrypted with the vault's `MasterPassword`, which is required to access any private keys contained in the XML vault.

## Object creation, unlocking and error handling

**Object Creation**

```foxpro
loXmlCertVault = CreateObject('Chilkat.XmlCertVault')
```

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.XmlCertVault.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 |
|---|---|---|
| `MasterPassword` | property, read/write | `MasterPassword As String` |
| `AddCert` | method | `AddCert(cert As ChilkatCert) As Number` |
| `AddCertBinary` | method | `AddCertBinary(certBytes As Variant) As Number` |
| `AddCertChain` | method | `AddCertChain(certChain As ChilkatCertChain) As Number` |
| `AddCertEncoded` | method | `AddCertEncoded(encodedBytes As String, encoding As String) As Number` |
| `AddCertFile` | method | `AddCertFile(path As String) As Number` |
| `AddCertString` | method | `AddCertString(certData As String) As Number` |
| `AddPemFile` | method | `AddPemFile(path As String, password As String) As Number` |
| `AddPfx` | method | `AddPfx(pfx As ChilkatPfx) As Number` |
| `AddPfxBinary` | method | `AddPfxBinary(pfxBytes As Variant, password As String) As Number` |
| `AddPfxEncoded` | method | `AddPfxEncoded(encodedBytes As String, encoding As String, password As String) As Number` |
| `AddPfxFile` | method | `AddPfxFile(path As String, password As String) As Number` |
| `GetXml` | method | `GetXml() As String` |
| `LoadXml` | method | `LoadXml(xml As String) As Number` |
| `LoadXmlFile` | method | `LoadXmlFile(path As String) As Number` |
| `SaveXml` | method | `SaveXml(path As String) As Number` |

## Properties

### XmlCertVault.MasterPassword

`Chilkat 11.7.0 · foxpro · XmlCertVault · MasterPassword · property · read/write · since 9.5.0.40`

```foxpro
MasterPassword As String
```

The master password for the vault. Certificates are stored unencrypted, but private keys are stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored 256-bit AES encrypted using the master password. The master password is required to acces any of the private keys stored within the XML vault.

## Methods

### XmlCertVault.AddCert

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCert · method · since 9.5.0.40`

```foxpro
AddCert(cert As ChilkatCert) As Number
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertBinary

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCertBinary · method · since 9.5.0.40`

```foxpro
AddCertBinary(certBytes As Variant) As Number
```

Adds a certificate to the XML vault from any binary format, such as DER.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertChain

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCertChain · method · since 9.5.0.40`

```foxpro
AddCertChain(certChain As ChilkatCertChain) As Number
```

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertEncoded

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCertEncoded · method · since 9.5.0.40`

```foxpro
AddCertEncoded(encodedBytes As String, encoding As String) As Number
```

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by `encoding`.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertFile

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCertFile · method · since 9.5.0.40`

```foxpro
AddCertFile(path As String) As Number
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertString

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddCertString · method · since 9.5.0.40`

```foxpro
AddCertString(certData As String) As Number
```

Adds a certificate from any string representation format such as PEM.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPemFile

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddPemFile · method · since 9.5.0.40`

```foxpro
AddPemFile(path As String, password As String) As Number
```

Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may contain one or more certificates and/or private keys. The password is optional and only required if the PEM file contains encrypted content that requires a password.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfx

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddPfx · method · since 9.5.0.40`

```foxpro
AddPfx(pfx As ChilkatPfx) As Number
```

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxBinary

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddPfxBinary · method · since 9.5.0.40`

```foxpro
AddPfxBinary(pfxBytes As Variant, password As String) As Number
```

Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddPfxEncoded · method`

```foxpro
AddPfxEncoded(encodedBytes As String, encoding As String, password As String) As Number
```

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by `encoding`.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxFile

`Chilkat 11.7.0 · foxpro · XmlCertVault · AddPfxFile · method · since 9.5.0.40`

```foxpro
AddPfxFile(path As String, password As String) As Number
```

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.GetXml

`Chilkat 11.7.0 · foxpro · XmlCertVault · GetXml · method · since 9.5.0.40`

```foxpro
GetXml() As String
```

Returns the contents of the cert vault as an XML string.

Returns `.NULL.` on failure

### XmlCertVault.LoadXml

`Chilkat 11.7.0 · foxpro · XmlCertVault · LoadXml · method · since 9.5.0.40`

```foxpro
LoadXml(xml As String) As Number
```

Loads from an XML string.

Returns 1 for success, 0 for failure.

### XmlCertVault.LoadXmlFile

`Chilkat 11.7.0 · foxpro · XmlCertVault · LoadXmlFile · method · since 9.5.0.40`

```foxpro
LoadXmlFile(path As String) As Number
```

Loads from an XML file.

Returns 1 for success, 0 for failure.

### XmlCertVault.SaveXml

`Chilkat 11.7.0 · foxpro · XmlCertVault · SaveXml · method · since 9.5.0.40`

```foxpro
SaveXml(path As String) As Number
```

Saves the contents to an XML file.

Returns 1 for success, 0 for failure.

## Related classes

[`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Cert.md), [`CertChain`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/CertChain.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Pfx.md)

