---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: XmlCertVault
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkXmlCertVaultRef.html
---
# Chilkat XmlCertVault — Delphi DLL — v11.7.0

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

```pascal
var
myObject: HCkXmlCertVault;

begin
myObject := CkXmlCertVault_Create();

// ...

CkXmlCertVault_Dispose(myObject);
end;
```

`function CkXmlCertVault_Create: HCkXmlCertVault; stdcall;`

Creates an instance of the HCkXmlCertVault object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

`procedure CkXmlCertVault_Dispose(handle: HCkXmlCertVault); stdcall;`

Objects created by calling CkXmlCertVault_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

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 Delphi DLL.

## 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` | `procedure CkXmlCertVault_getDebugLogFilePath(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; procedure CkXmlCertVault_putDebugLogFilePath(objHandle: HCkXmlCertVault; newPropVal: PWideChar); stdcall; function CkXmlCertVault__debugLogFilePath(objHandle: HCkXmlCertVault): PWideChar; stdcall;` | 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` | `procedure CkXmlCertVault_getLastErrorHtml(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; function CkXmlCertVault__lastErrorHtml(objHandle: HCkXmlCertVault): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkXmlCertVault_getLastErrorText(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; function CkXmlCertVault__lastErrorText(objHandle: HCkXmlCertVault): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkXmlCertVault_getLastErrorXml(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; function CkXmlCertVault__lastErrorXml(objHandle: HCkXmlCertVault): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkXmlCertVault_getLastMethodSuccess(objHandle: HCkXmlCertVault): wordbool; stdcall; procedure CkXmlCertVault_putLastMethodSuccess(objHandle: HCkXmlCertVault; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkXmlCertVault_getVerboseLogging(objHandle: HCkXmlCertVault): wordbool; stdcall; procedure CkXmlCertVault_putVerboseLogging(objHandle: HCkXmlCertVault; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkXmlCertVault_getVersion(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; function CkXmlCertVault__version(objHandle: HCkXmlCertVault): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MasterPassword` | property, read/write | `procedure CkXmlCertVault_getMasterPassword(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall; procedure CkXmlCertVault_putMasterPassword(objHandle: HCkXmlCertVault; newPropVal: PWideChar); stdcall; function CkXmlCertVault__masterPassword(objHandle: HCkXmlCertVault): PWideChar; stdcall;` |
| `AddCert` | method | `function CkXmlCertVault_AddCert(objHandle: HCkXmlCertVault;     cert: HCkCert): wordbool; stdcall;` |
| `AddCertChain` | method | `function CkXmlCertVault_AddCertChain(objHandle: HCkXmlCertVault;     certChain: HCkCertChain): wordbool; stdcall;` |
| `AddCertEncoded` | method | `function CkXmlCertVault_AddCertEncoded(objHandle: HCkXmlCertVault;     encodedBytes: PWideChar;     encoding: PWideChar): wordbool; stdcall;` |
| `AddCertFile` | method | `function CkXmlCertVault_AddCertFile(objHandle: HCkXmlCertVault;     path: PWideChar): wordbool; stdcall;` |
| `AddCertString` | method | `function CkXmlCertVault_AddCertString(objHandle: HCkXmlCertVault;     certData: PWideChar): wordbool; stdcall;` |
| `AddPemFile` | method | `function CkXmlCertVault_AddPemFile(objHandle: HCkXmlCertVault;     path: PWideChar;     password: PWideChar): wordbool; stdcall;` |
| `AddPfx` | method | `function CkXmlCertVault_AddPfx(objHandle: HCkXmlCertVault;     pfx: HCkPfx): wordbool; stdcall;` |
| `AddPfxEncoded` | method | `function CkXmlCertVault_AddPfxEncoded(objHandle: HCkXmlCertVault;     encodedBytes: PWideChar;     encoding: PWideChar;     password: PWideChar): wordbool; stdcall;` |
| `AddPfxFile` | method | `function CkXmlCertVault_AddPfxFile(objHandle: HCkXmlCertVault;     path: PWideChar;     password: PWideChar): wordbool; stdcall;` |
| `GetXml` | method | `function CkXmlCertVault_GetXml(objHandle: HCkXmlCertVault;     outStr: HCkString): wordbool; stdcall; function CkXmlCertVault__getXml(objHandle: HCkXmlCertVault): PWideChar; stdcall;` |
| `LoadXml` | method | `function CkXmlCertVault_LoadXml(objHandle: HCkXmlCertVault;     xml: PWideChar): wordbool; stdcall;` |
| `LoadXmlFile` | method | `function CkXmlCertVault_LoadXmlFile(objHandle: HCkXmlCertVault;     path: PWideChar): wordbool; stdcall;` |
| `SaveXml` | method | `function CkXmlCertVault_SaveXml(objHandle: HCkXmlCertVault;     path: PWideChar): wordbool; stdcall;` |

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 · delphidll · XmlCertVault · MasterPassword · property · read/write · since 9.5.0.40`

```pascal
procedure CkXmlCertVault_getMasterPassword(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
procedure CkXmlCertVault_putMasterPassword(objHandle: HCkXmlCertVault; newPropVal: PWideChar); stdcall;
function CkXmlCertVault__masterPassword(objHandle: HCkXmlCertVault): PWideChar; stdcall;
```

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

```pascal
function CkXmlCertVault_AddCert(objHandle: HCkXmlCertVault;
    cert: HCkCert): wordbool; stdcall;
```

Adds a certificate to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertChain

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

```pascal
function CkXmlCertVault_AddCertChain(objHandle: HCkXmlCertVault;
    certChain: HCkCertChain): wordbool; stdcall;
```

Adds a chain of certificates to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertEncoded

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

```pascal
function CkXmlCertVault_AddCertEncoded(objHandle: HCkXmlCertVault;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
```

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

```pascal
function CkXmlCertVault_AddCertFile(objHandle: HCkXmlCertVault;
    path: PWideChar): wordbool; stdcall;
```

Adds a certificate to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertString

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

```pascal
function CkXmlCertVault_AddCertString(objHandle: HCkXmlCertVault;
    certData: PWideChar): wordbool; stdcall;
```

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

Returns True for success, False for failure.

### XmlCertVault.AddPemFile

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

```pascal
function CkXmlCertVault_AddPemFile(objHandle: HCkXmlCertVault;
    path: PWideChar;
    password: PWideChar): wordbool; stdcall;
```

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

```pascal
function CkXmlCertVault_AddPfx(objHandle: HCkXmlCertVault;
    pfx: HCkPfx): wordbool; stdcall;
```

Adds a PFX (PKCS12) to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · delphidll · XmlCertVault · AddPfxEncoded · method`

```pascal
function CkXmlCertVault_AddPfxEncoded(objHandle: HCkXmlCertVault;
    encodedBytes: PWideChar;
    encoding: PWideChar;
    password: PWideChar): wordbool; stdcall;
```

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

```pascal
function CkXmlCertVault_AddPfxFile(objHandle: HCkXmlCertVault;
    path: PWideChar;
    password: PWideChar): wordbool; stdcall;
```

Adds a PFX file to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.GetXml

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

```pascal
function CkXmlCertVault_GetXml(objHandle: HCkXmlCertVault;
    outStr: HCkString): wordbool; stdcall;
function CkXmlCertVault__getXml(objHandle: HCkXmlCertVault): PWideChar; stdcall;
```

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

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### XmlCertVault.LoadXml

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

```pascal
function CkXmlCertVault_LoadXml(objHandle: HCkXmlCertVault;
    xml: PWideChar): wordbool; stdcall;
```

Loads from an XML string.

Returns True for success, False for failure.

### XmlCertVault.LoadXmlFile

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

```pascal
function CkXmlCertVault_LoadXmlFile(objHandle: HCkXmlCertVault;
    path: PWideChar): wordbool; stdcall;
```

Loads from an XML file.

Returns True for success, False for failure.

### XmlCertVault.SaveXml

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

```pascal
function CkXmlCertVault_SaveXml(objHandle: HCkXmlCertVault;
    path: PWideChar): wordbool; stdcall;
```

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

