XmlCertVault Zig Reference Documentation

XmlCertVault

Current Version: 11.6.1

Chilkat.XmlCertVault

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

// Add the package once:
//     zig fetch --save https://chilkatdownload.com/11.6.1/chilkat-zig-11.6.1.tar.gz
// and in build.zig:
//     const chilkat = b.dependency("chilkat", .{ .target = target, .optimize = optimize });
//     exe.root_module.addImport("chilkat", chilkat.module("chilkat"));
const chilkat = @import("chilkat");

// Once per process, before any other Chilkat call:
try chilkat.unlockBundle("Anything for 30-day trial");

const xml_cert_vault = try chilkat.XmlCertVault.init();
defer xml_cert_vault.deinit();

pub fn init() Allocator.Error!XmlCertVault

Creates the underlying native Chilkat object. XmlCertVault is a one-pointer struct passed by value; copying it copies the handle (two names for one object). Returns error.OutOfMemory if the library could not allocate the object. Use an object from one thread at a time; it may be handed from one thread to another.

pub fn deinit(self: XmlCertVault) void

Releases the native object. Call it exactly once per object (usually with defer); the handle is invalid afterwards. Objects returned by methods are owned by the caller too and are released the same way.

pub fn fromHandle(h: *chilkat.c.CkXmlCertVault.HCkXmlCertVault) XmlCertVault

Wraps a handle obtained from the C API (chilkat.c.CkXmlCertVault), taking ownership of it. The struct's handle field goes the other way, for anything the Zig API does not cover.

Errors and memory

Methods that can fail return an error union: a method whose only outcome is success or failure returns Error!void; a method producing a string returns (Error || Allocator.Error)![:0]u8; a method producing an object returns Error!T. chilkat.Error is error{ChilkatFailed}; the reason for a failure is in getLastErrorText, and the object remains usable. Properties never fail, and methods that answer a question (hasMember, isUnlocked, ...) return a plain bool.

String arguments are [:0]const u8 (UTF-8; string literals can be passed as is). String results are copies allocated with the allocator argument and owned by the caller, so they stay valid across later calls on the same object.

const text = xml_cert_vault.someMethod(allocator, ...) catch |err| {
    const why = try xml_cert_vault.getLastErrorText(allocator);
    defer allocator.free(why);
    std.debug.print("{s}\n", .{why});
    return err;
};
defer allocator.free(text);

Properties

DebugLogFilePath

// read/write
pub fn getDebugLogFilePath(self: XmlCertVault, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: XmlCertVault, value: [:0]const u8) void

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

XmlCertVault Zig Reference Documentation

XmlCertVault

Current Version: 11.6.1

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

Add certificates

Add certificate chains

Add PEM content

Add PFX / PKCS12

Master password protection

Load and save XML

Object Creation

Errors and memory

Properties

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

MasterPassword

VerboseLogging

Version

Methods

AddCert

AddCertChain

AddCertEncoded

AddCertFile

AddCertString

AddPemFile

AddPfx

AddPfxEncoded

AddPfxFile

GetXml

LoadXml

LoadXmlFile

SaveXml