---
product: Chilkat
product_version: 11.7.0
language: xbase
language_label: Xbase++
class: XmlCertVault
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xbase_XmlCertVaultRef.html
---
# Chilkat XmlCertVault — Xbase++ — v11.7.0

> Chilkat 11.7.0 · language=xbase · 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/xbase/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**

```xbase
LOCAL oXmlCertVault
oXmlCertVault := CreateObject("Chilkat.XmlCertVault")

// ... use oXmlCertVault ...

oXmlCertVault:destroy()
```

Xbase++ uses the Chilkat ActiveX through the automation object returned by `CreateObject()`; properties and methods are accessed with the send operator (`oHttp:ConnectTimeout := 30`, `oHttp:Download(cUrl, cPath)`), and `:destroy()` releases the object. Register the Chilkat ActiveX matching the bitness of your Xbase++ application. 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.\*.\*.

Boolean properties, arguments and return values are integers in the ActiveX: pass `1` or `0`, and test a method's success with `== 1`. A method that fails to return an object returns `NIL`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are automation objects too and should likewise be released with `:destroy()`. Methods and properties that pass or return raw byte arrays are not shown on this page; use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead.

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 Xbase++.

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` | `oXmlCertVault:DebugLogFilePath // Character` | 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` | `oXmlCertVault:LastErrorHtml // Character (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `oXmlCertVault:LastErrorText // Character (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `oXmlCertVault:LastErrorXml // Character (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `oXmlCertVault:LastMethodSuccess // Numeric` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `oXmlCertVault:LastStringResult // Character (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` | `oXmlCertVault:LastStringResultLen // Numeric (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `oXmlCertVault:VerboseLogging // Numeric` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `oXmlCertVault:Version // Character (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MasterPassword` | property, read/write | `oXmlCertVault:MasterPassword // Character` |
| `AddCert` | method | `nSuccess := oXmlCertVault:AddCert(oCert) // returns Numeric (1/0)` |
| `AddCertChain` | method | `nSuccess := oXmlCertVault:AddCertChain(oCertChain) // returns Numeric (1/0)` |
| `AddCertEncoded` | method | `nSuccess := oXmlCertVault:AddCertEncoded(cEncodedBytes, cEncoding) // returns Numeric (1/0)` |
| `AddCertFile` | method | `nSuccess := oXmlCertVault:AddCertFile(cPath) // returns Numeric (1/0)` |
| `AddCertString` | method | `nSuccess := oXmlCertVault:AddCertString(cCertData) // returns Numeric (1/0)` |
| `AddPemFile` | method | `nSuccess := oXmlCertVault:AddPemFile(cPath, cPassword) // returns Numeric (1/0)` |
| `AddPfx` | method | `nSuccess := oXmlCertVault:AddPfx(oPfx) // returns Numeric (1/0)` |
| `AddPfxEncoded` | method | `nSuccess := oXmlCertVault:AddPfxEncoded(cEncodedBytes, cEncoding, cPassword) // returns Numeric (1/0)` |
| `AddPfxFile` | method | `nSuccess := oXmlCertVault:AddPfxFile(cPath, cPassword) // returns Numeric (1/0)` |
| `GetXml` | method | `cResult := oXmlCertVault:GetXml() // returns Character` |
| `LoadXml` | method | `nSuccess := oXmlCertVault:LoadXml(cXml) // returns Numeric (1/0)` |
| `LoadXmlFile` | method | `nSuccess := oXmlCertVault:LoadXmlFile(cPath) // returns Numeric (1/0)` |
| `SaveXml` | method | `nSuccess := oXmlCertVault:SaveXml(cPath) // returns Numeric (1/0)` |

## Properties

### XmlCertVault.MasterPassword

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

```xbase
oXmlCertVault:MasterPassword  // Character
```

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 · xbase · XmlCertVault · AddCert · method · since 9.5.0.40`

```xbase
nSuccess := oXmlCertVault:AddCert(oCert)  // returns Numeric (1/0)
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertChain

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

```xbase
nSuccess := oXmlCertVault:AddCertChain(oCertChain)  // returns Numeric (1/0)
```

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertEncoded

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

```xbase
nSuccess := oXmlCertVault:AddCertEncoded(cEncodedBytes, cEncoding)  // returns Numeric (1/0)
```

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 · xbase · XmlCertVault · AddCertFile · method · since 9.5.0.40`

```xbase
nSuccess := oXmlCertVault:AddCertFile(cPath)  // returns Numeric (1/0)
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertString

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

```xbase
nSuccess := oXmlCertVault:AddCertString(cCertData)  // returns Numeric (1/0)
```

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

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPemFile

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

```xbase
nSuccess := oXmlCertVault:AddPemFile(cPath, cPassword)  // returns Numeric (1/0)
```

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 · xbase · XmlCertVault · AddPfx · method · since 9.5.0.40`

```xbase
nSuccess := oXmlCertVault:AddPfx(oPfx)  // returns Numeric (1/0)
```

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · xbase · XmlCertVault · AddPfxEncoded · method`

```xbase
nSuccess := oXmlCertVault:AddPfxEncoded(cEncodedBytes, cEncoding, cPassword)  // returns Numeric (1/0)
```

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 · xbase · XmlCertVault · AddPfxFile · method · since 9.5.0.40`

```xbase
nSuccess := oXmlCertVault:AddPfxFile(cPath, cPassword)  // returns Numeric (1/0)
```

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.GetXml

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

```xbase
cResult := oXmlCertVault:GetXml()  // returns Character
```

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

Returns `NIL` on failure

### XmlCertVault.LoadXml

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

```xbase
nSuccess := oXmlCertVault:LoadXml(cXml)  // returns Numeric (1/0)
```

Loads from an XML string.

Returns 1 for success, 0 for failure.

### XmlCertVault.LoadXmlFile

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

```xbase
nSuccess := oXmlCertVault:LoadXmlFile(cPath)  // returns Numeric (1/0)
```

Loads from an XML file.

Returns 1 for success, 0 for failure.

### XmlCertVault.SaveXml

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

```xbase
nSuccess := oXmlCertVault:SaveXml(cPath)  // returns Numeric (1/0)
```

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/xbase/classes/Cert.md), [`CertChain`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/CertChain.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/Pfx.md)

