Pem Zig Reference Documentation

Pem

Current Version: 11.6.1

Chilkat.Pem

Load, inspect, assemble, export, and convert PEM certificate and key material.

Chilkat.Pem is the Chilkat class for handling PEM-formatted certificate and key material. It can load PEM and PKCS#7 data, add certificates, private keys, public keys, CSRs, and certificate chains, retrieve individual items, remove content, control PKCS#1 vs. PKCS#8 private key output, export PEM with optional encryption and extended attributes, and convert PEM material to PFX or Java KeyStore objects.

Load PEM and PKCS#7

Load PEM-encoded certificates, keys, CSRs, and PKCS#7 certificate data from files, strings, or memory.

Collect certs and keys

Add certificates, private keys, public keys, CSRs, and certificate chains into a single PEM container.

Retrieve individual items

Extract selected certificates, keys, CSRs, or chains for use with Cert, PrivateKey, PublicKey, or related Chilkat classes.

Private-key format control

Choose PKCS#1 or PKCS#8 private-key output depending on the format required by the target system.

Encrypted PEM output

Export private-key material with password-based encryption when PEM data must be stored or transferred securely.

Convert to PFX or JKS

Convert PEM certificates and keys into PFX/P12 or Java KeyStore objects when another platform or API requires those container formats.

Common pattern: Use Pem when certificate and key material is packaged as one or more PEM blocks. Load the PEM, inspect or retrieve the needed items, add or remove entries as needed, then export the result as PEM, PFX/P12, or Java KeyStore data. Use Chilkat.Cert, PrivateKey, and PublicKey when working directly with individual objects.

For an extended overview, see Pem 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 pem = try chilkat.Pem.init();
defer pem.deinit();

pub fn init() Allocator.Error!Pem

Creates the underlying native Chilkat object. Pem 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: Pem) 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.CkPem.HCkPem) Pem

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

Properties

AppendMode

// read/write
pub fn getAppendMode(self: Pem) bool
pub fn setAppendMode(self: Pem, value: bool) void

Introduced in version 9.5.0.49

When set to true, each of the Load* methods appends to the current contents of this PEM object. When set to false, a Load* method replaces the contents of this PEM object. The default is false.

Pem Zig Reference Documentation

Pem

Current Version: 11.6.1

Load, inspect, assemble, export, and convert PEM certificate and key material.

Load PEM and PKCS#7

Collect certs and keys

Retrieve individual items

Private-key format control

Encrypted PEM output

Convert to PFX or JKS

Object Creation

Errors and memory

Properties

AppendMode

DebugLogFilePath

HeartbeatMs

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCerts

NumCrls

NumCsrs

NumPrivateKeys

NumPublicKeys

PrivateKeyFormat

PublicKeyFormat

VerboseLogging

Version

Methods

AddCert

AddItem

AddP7b

AddPrivateKey

AddPrivateKey2

AddPublicKey

CertAt

Clear

GetEncodedItem

LoadP7bFile

LoadPem

LoadPemFile

PrivateKeyAt

PublicKeyAt

RemoveCert

RemovePrivateKey

ToJksObj

ToPem

ToPemEx

ToPfxObj