Rsa Zig Reference Documentation

Rsa

Current Version: 11.6.1

Chilkat.Rsa

Encrypt, decrypt, sign, verify, and generate RSA keys.

Use Chilkat.Rsa when an application needs direct RSA cryptographic operations. It can encrypt data with a public key, decrypt with a private key, create RSA signatures, verify signatures, sign precomputed hashes, verify signed hashes, and generate RSA key pairs. It also works with keys supplied directly as PrivateKey or PublicKey objects, or indirectly through certificates.

RSA encryption

Encrypt data with a public key for workflows where only the matching private key should be able to decrypt the result.

RSA decryption

Decrypt RSA-encrypted data using a private key, including keys loaded directly or accessed through a certificate.

Sign and verify data

Create and verify RSA signatures over data using the hash algorithm and padding mode required by the application or protocol.

Sign precomputed hashes

Sign or verify already-computed message digests when the hashing step is performed separately or by another component.

Generate RSA keys

Generate RSA key pairs for applications that need new public/private key material.

Certificate-backed keys

Use RSA keys associated with certificates, including non-exportable private keys in smart cards, USB tokens, Windows stores, or Apple Keychain.

Common pattern: Load or generate the RSA key material, configure the padding, hash, charset, and encoding options needed by the protocol, then call the method matching the operation: encrypt, decrypt, sign, verify, sign-hash, or verify-hash. Use Chilkat.Rsa for direct RSA operations; use higher-level classes such as Crypt2, Jws, Jwt, or Mime when the RSA operation is part of a larger format or protocol.

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

pub fn init() Allocator.Error!Rsa

Creates the underlying native Chilkat object. Rsa 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: Rsa) 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.CkRsa.HCkRsa) Rsa

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

Properties

Charset

// read/write
pub fn getCharset(self: Rsa, allocator: Allocator) Allocator.Error![:0]u8
pub fn setCharset(self: Rsa, value: [:0]const u8) void

This property specifies the character encoding used to represent text as bytes for encryption, decryption, signing, and signature validation. By default, it uses the computer's ANSI charset, such as Windows-1252 for locales like the United States, United Kingdom, Western Europe, Australia, and New Zealand.

Most applications are advised to set this property to UTF-8. Chilkat plans to change its default to UTF-8 in a future major version to align with current standards. The current default of ANSI stems from a time when UTF-8 was not widely adopted.

More Information and Examples

How Charset Affects RSA ANSI Charset Explained Charset Considerations when RSA Encrypting Strings

Rsa Zig Reference Documentation

Rsa

Current Version: 11.6.1

Encrypt, decrypt, sign, verify, and generate RSA keys.

RSA encryption

RSA decryption

Sign and verify data

Sign precomputed hashes

Generate RSA keys

Certificate-backed keys

Object Creation

Errors and memory

Properties

Charset

DebugLogFilePath

EncodingMode

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

LittleEndian

NoUnpad

NumBits

OaepHash

OaepLabel

OaepMgfHash

PkcsPadding

PssSaltLen

UncommonOptions

VerboseLogging

Version

Methods

DecryptBd

DecryptStringENC

EncryptBd

EncryptStringENC

GenKey

SetX509Cert

SignBd

SignHashENC

SignRawBd

SignStringENC

SnkToXml

UsePrivateKey

UsePublicKey

VerifyBd

VerifyHashENC

VerifyRawBd

VerifyStringENC