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

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

```autoit
Local $oXmlCertVault = ObjCreate("Chilkat.XmlCertVault")
```

Register the 32-bit or 64-bit Chilkat ActiveX to match the AutoIt interpreter running the script (AutoIt3.exe or AutoIt3_x64.exe). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ObjCreate("Chilkat.XmlCertVault.11")` for Chilkat v11.\*.\*.

Boolean properties and arguments are integers in the ActiveX (1 or 0); AutoIt's `True` and `False` convert to them automatically. A method that fails to return an object returns `Null`. 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 AutoIt.

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 ; 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. |
| `LastErrorHtml` | `LastErrorHtml ; String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText ; String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml ; String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess ; Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `LastStringResult` | `LastStringResult ; 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 ; Integer (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging ; Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version ; 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 ; String` |
| `AddCert` | method | `AddCert($oCert) ; returns Boolean` |
| `AddCertChain` | method | `AddCertChain($oCertChain) ; returns Boolean` |
| `AddCertEncoded` | method | `AddCertEncoded($sEncodedBytes, $sEncoding) ; returns Boolean` |
| `AddCertFile` | method | `AddCertFile($sPath) ; returns Boolean` |
| `AddCertString` | method | `AddCertString($sCertData) ; returns Boolean` |
| `AddPemFile` | method | `AddPemFile($sPath, $sPassword) ; returns Boolean` |
| `AddPfx` | method | `AddPfx($oPfx) ; returns Boolean` |
| `AddPfxEncoded` | method | `AddPfxEncoded($sEncodedBytes, $sEncoding, $sPassword) ; returns Boolean` |
| `AddPfxFile` | method | `AddPfxFile($sPath, $sPassword) ; returns Boolean` |
| `GetXml` | method | `GetXml() ; returns String` |
| `LoadXml` | method | `LoadXml($sXml) ; returns Boolean` |
| `LoadXmlFile` | method | `LoadXmlFile($sPath) ; returns Boolean` |
| `SaveXml` | method | `SaveXml($sPath) ; returns Boolean` |

## Properties

### XmlCertVault.MasterPassword

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

```autoit
MasterPassword  ; 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 · autoit · XmlCertVault · AddCert · method · since 9.5.0.40`

```autoit
AddCert($oCert)  ; returns Boolean
```

Adds a certificate to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertChain

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

```autoit
AddCertChain($oCertChain)  ; returns Boolean
```

Adds a chain of certificates to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertEncoded

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

```autoit
AddCertEncoded($sEncodedBytes, $sEncoding)  ; returns Boolean
```

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

```autoit
AddCertFile($sPath)  ; returns Boolean
```

Adds a certificate to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddCertString

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

```autoit
AddCertString($sCertData)  ; returns Boolean
```

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

Returns True for success, False for failure.

### XmlCertVault.AddPemFile

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

```autoit
AddPemFile($sPath, $sPassword)  ; returns Boolean
```

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

```autoit
AddPfx($oPfx)  ; returns Boolean
```

Adds a PFX (PKCS12) to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · autoit · XmlCertVault · AddPfxEncoded · method`

```autoit
AddPfxEncoded($sEncodedBytes, $sEncoding, $sPassword)  ; returns Boolean
```

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

```autoit
AddPfxFile($sPath, $sPassword)  ; returns Boolean
```

Adds a PFX file to the XML vault.

Returns True for success, False for failure.

### XmlCertVault.GetXml

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

```autoit
GetXml()  ; returns String
```

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

Returns `Null` on failure

### XmlCertVault.LoadXml

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

```autoit
LoadXml($sXml)  ; returns Boolean
```

Loads from an XML string.

Returns True for success, False for failure.

### XmlCertVault.LoadXmlFile

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

```autoit
LoadXmlFile($sPath)  ; returns Boolean
```

Loads from an XML file.

Returns True for success, False for failure.

### XmlCertVault.SaveXml

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

```autoit
SaveXml($sPath)  ; returns Boolean
```

Saves the contents to an XML file.

Returns True for success, False for failure.

## Related classes

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

