CertStore Zig Reference Documentation

CertStore

Current Version: 11.6.1

Chilkat.CertStore

Open, search, manage, and use certificate collections from many sources.

Chilkat.CertStore is the Chilkat class for working with collections of X.509 certificates. It can open and manage certificates from system stores, Apple Keychain, Windows registry or file stores, memory stores, PEM files, PFX/P12 files, and smart card or USB token devices. It supports loading, searching, iterating, adding, removing, and closing certificate stores, with platform-specific behavior for Windows and Apple Keychain.

Open certificate stores

Access certificates from Windows certificate stores, Apple Keychain, files, memory stores, PEM bundles, PFX/P12 files, and hardware tokens.

Search and retrieve certs

Find certificates by subject, issuer, serial number, thumbprint, email, private-key availability, or other identifying information.

Iterate collections

Enumerate certificates in a store and retrieve each certificate as a Chilkat.Cert object for inspection or use.

Add and remove certificates

Add certificates to writable stores, remove certificates where supported, and manage store contents from application code.

Private-key backed certs

Work with certificates that have associated private keys from PFX/P12, operating-system stores, smart cards, USB tokens, or other providers.

Use across Chilkat

Pass retrieved certificates to other Chilkat classes for TLS client authentication, S/MIME, signing, encryption, decryption, and verification.

Common pattern: Open the appropriate certificate store, search or iterate to find the needed certificate, retrieve it as a Chilkat.Cert, and then pass that certificate to the Chilkat class that needs it. Use certificate stores when the application should select from existing system, file-based, keychain, or hardware-backed certificates.

For an extended overview, see CertStore Class Overview.

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 cert_store = try chilkat.CertStore.init();
defer cert_store.deinit();

pub fn init() Allocator.Error!CertStore

Creates the underlying native Chilkat object. CertStore 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: CertStore) 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.CkCertStore.HCkCertStore) CertStore

Wraps a handle obtained from the C API (chilkat.c.CkCertStore), 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 = cert_store.someMethod(allocator, ...) catch |err| {
    const why = try cert_store.getLastErrorText(allocator);
    defer allocator.free(why);
    std.debug.print("{s}\n", .{why});
    return err;
};
defer allocator.free(text);

Properties

AvoidWindowsPkAccess

// read/write
pub fn getAvoidWindowsPkAccess(self: CertStore) bool
pub fn setAvoidWindowsPkAccess(self: CertStore, value: bool) void

Applies only when running on a Microsoft Windows operating system. If true, then any method that returns a certificate will not try to also access the associated private key, assuming one exists. This is useful if the certificate was installed with high-security such that a private key access would trigger the Windows OS to display a security warning dialog. The default value of this property is false.

CertStore Zig Reference Documentation

CertStore

Current Version: 11.6.1

Open, search, manage, and use certificate collections from many sources.

Open certificate stores

Search and retrieve certs

Iterate collections

Add and remove certificates

Private-key backed certs

Use across Chilkat

Object Creation

Errors and memory

Properties

AvoidWindowsPkAccess

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCertificates

SmartCardPin

UncommonOptions

VerboseLogging

Version

Methods

AddCertificate

CloseCertStore

CreateFileStore

CreateMemoryStore

CreateRegistryStore

FindCert

GetCert

LoadPemFile

LoadPemStr

LoadPfxBd

LoadPfxFile

OpenCurrentUserStore

OpenFileStore

OpenLocalSystemStore

OpenRegistryStore

OpenSmartcard

OpenWindowsStore

RemoveCertificate