---
product: Chilkat
product_version: 11.7.0
language: wc
language_label: Unicode C
class: XmlCertVault
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wc_CkXmlCertVaultWRef.html
---
# Chilkat XmlCertVault — Unicode C — v11.7.0

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

**Create/Dispose**

```c
HCkXmlCertVaultW instance = CkXmlCertVaultW_Create();
// ...
CkXmlCertVaultW_Dispose(instance);
```

`HCkXmlCertVaultW CkXmlCertVaultW_Create(void);`

Creates an instance of the HCkXmlCertVaultW object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkXmlCertVaultW_Dispose(HCkXmlCertVaultW handle);`

Objects created by calling CkXmlCertVaultW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkXmlCertVaultW_Dispose.

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 Unicode C.

## 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` | `void CkXmlCertVaultW_getDebugLogFilePath(HCkXmlCertVaultW cHandle, HCkString retval); void CkXmlCertVaultW_putDebugLogFilePath(HCkXmlCertVaultW cHandle, const wchar_t *newVal); const wchar_t *CkXmlCertVaultW_debugLogFilePath(HCkXmlCertVaultW cHandle);` | 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` | `void CkXmlCertVaultW_getLastErrorHtml(HCkXmlCertVaultW cHandle, HCkString retval); const wchar_t *CkXmlCertVaultW_lastErrorHtml(HCkXmlCertVaultW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkXmlCertVaultW_getLastErrorText(HCkXmlCertVaultW cHandle, HCkString retval); const wchar_t *CkXmlCertVaultW_lastErrorText(HCkXmlCertVaultW cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkXmlCertVaultW_getLastErrorXml(HCkXmlCertVaultW cHandle, HCkString retval); const wchar_t *CkXmlCertVaultW_lastErrorXml(HCkXmlCertVaultW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkXmlCertVaultW_getLastMethodSuccess(HCkXmlCertVaultW cHandle); void CkXmlCertVaultW_putLastMethodSuccess(HCkXmlCertVaultW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `VerboseLogging` | `BOOL CkXmlCertVaultW_getVerboseLogging(HCkXmlCertVaultW cHandle); void CkXmlCertVaultW_putVerboseLogging(HCkXmlCertVaultW cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkXmlCertVaultW_getVersion(HCkXmlCertVaultW cHandle, HCkString retval); const wchar_t *CkXmlCertVaultW_version(HCkXmlCertVaultW cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MasterPassword` | property, read/write | `void CkXmlCertVaultW_getMasterPassword(HCkXmlCertVaultW cHandle, HCkString retval); void CkXmlCertVaultW_putMasterPassword(HCkXmlCertVaultW cHandle, const wchar_t *newVal); const wchar_t *CkXmlCertVaultW_masterPassword(HCkXmlCertVaultW cHandle);` |
| `AddCert` | method | `BOOL CkXmlCertVaultW_AddCert(HCkXmlCertVaultW cHandle, HCkCertW cert);` |
| `AddCertChain` | method | `BOOL CkXmlCertVaultW_AddCertChain(HCkXmlCertVaultW cHandle, HCkCertChainW certChain);` |
| `AddCertEncoded` | method | `BOOL CkXmlCertVaultW_AddCertEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *encoding);` |
| `AddCertFile` | method | `BOOL CkXmlCertVaultW_AddCertFile(HCkXmlCertVaultW cHandle, const wchar_t *path);` |
| `AddCertString` | method | `BOOL CkXmlCertVaultW_AddCertString(HCkXmlCertVaultW cHandle, const wchar_t *certData);` |
| `AddPemFile` | method | `BOOL CkXmlCertVaultW_AddPemFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *password);` |
| `AddPfx` | method | `BOOL CkXmlCertVaultW_AddPfx(HCkXmlCertVaultW cHandle, HCkPfxW pfx);` |
| `AddPfxEncoded` | method | `BOOL CkXmlCertVaultW_AddPfxEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *encoding, const wchar_t *password);` |
| `AddPfxFile` | method | `BOOL CkXmlCertVaultW_AddPfxFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *password);` |
| `GetXml` | method | `BOOL CkXmlCertVaultW_GetXml(HCkXmlCertVaultW cHandle, const wchar_t *outStr); const wchar_t *CkXmlCertVaultW_getXml(HCkXmlCertVaultW cHandle);` |
| `LoadXml` | method | `BOOL CkXmlCertVaultW_LoadXml(HCkXmlCertVaultW cHandle, const wchar_t *xml);` |
| `LoadXmlFile` | method | `BOOL CkXmlCertVaultW_LoadXmlFile(HCkXmlCertVaultW cHandle, const wchar_t *path);` |
| `SaveXml` | method | `BOOL CkXmlCertVaultW_SaveXml(HCkXmlCertVaultW cHandle, const wchar_t *path);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### XmlCertVault.MasterPassword

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

```c
void CkXmlCertVaultW_getMasterPassword(HCkXmlCertVaultW cHandle, HCkString retval);
void CkXmlCertVaultW_putMasterPassword(HCkXmlCertVaultW cHandle, const wchar_t *newVal);
const wchar_t *CkXmlCertVaultW_masterPassword(HCkXmlCertVaultW cHandle);
```

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

```c
BOOL CkXmlCertVaultW_AddCert(HCkXmlCertVaultW cHandle, HCkCertW cert);
```

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.AddCertChain

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

```c
BOOL CkXmlCertVaultW_AddCertChain(HCkXmlCertVaultW cHandle, HCkCertChainW certChain);
```

Adds a chain of certificates to the XML vault.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.AddCertEncoded

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

```c
BOOL CkXmlCertVaultW_AddCertEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *encoding);
```

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 TRUE for success, FALSE for failure.

### XmlCertVault.AddCertFile

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

```c
BOOL CkXmlCertVaultW_AddCertFile(HCkXmlCertVaultW cHandle, const wchar_t *path);
```

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.AddCertString

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

```c
BOOL CkXmlCertVaultW_AddCertString(HCkXmlCertVaultW cHandle, const wchar_t *certData);
```

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

Returns TRUE for success, FALSE for failure.

### XmlCertVault.AddPemFile

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

```c
BOOL CkXmlCertVaultW_AddPemFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *password);
```

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 TRUE for success, FALSE for failure.

### XmlCertVault.AddPfx

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

```c
BOOL CkXmlCertVaultW_AddPfx(HCkXmlCertVaultW cHandle, HCkPfxW pfx);
```

Adds a PFX (PKCS12) to the XML vault.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · wc · XmlCertVault · AddPfxEncoded · method`

```c
BOOL CkXmlCertVaultW_AddPfxEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *encoding, const wchar_t *password);
```

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 TRUE for success, FALSE for failure.

### XmlCertVault.AddPfxFile

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

```c
BOOL CkXmlCertVaultW_AddPfxFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *password);
```

Adds a PFX file to the XML vault.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.GetXml

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

```c
BOOL CkXmlCertVaultW_GetXml(HCkXmlCertVaultW cHandle, const wchar_t *outStr);
const wchar_t *CkXmlCertVaultW_getXml(HCkXmlCertVaultW cHandle);
```

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

Returns TRUE for success, FALSE for failure.

### XmlCertVault.LoadXml

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

```c
BOOL CkXmlCertVaultW_LoadXml(HCkXmlCertVaultW cHandle, const wchar_t *xml);
```

Loads from an XML string.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.LoadXmlFile

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

```c
BOOL CkXmlCertVaultW_LoadXmlFile(HCkXmlCertVaultW cHandle, const wchar_t *path);
```

Loads from an XML file.

Returns TRUE for success, FALSE for failure.

### XmlCertVault.SaveXml

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

```c
BOOL CkXmlCertVaultW_SaveXml(HCkXmlCertVaultW cHandle, const wchar_t *path);
```

Saves the contents to an XML file.

Returns TRUE for success, FALSE for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `AddCertBinary` | method | before 11.6.1 | — |
| `AddPfxBinary` | method | before 11.6.1 | — |

## Related classes

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

