Asn Zig Reference Documentation
Asn
Current Version: 11.6.1
Chilkat.Asn
Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex,
files, or existing
Read the item tag, tag value, constructed/primitive state, sub-item
count, string content, boolean value, or integer value.
Append constructed
Add booleans, integers, big integers, bit strings, octet strings, OIDs,
strings, times, null values, and encoded byte content.
Add context-specific primitive or constructed items when working with
ASN.1 formats that use tagged application-specific structures.
Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML,
and output the result as binary or encoded DER.
Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.
Chilkat.Asn represents an ASN.1 item and its optional child
items. It can load ASN.1 from binary DER, encoded DER strings, files, or
BinData; expose tags, tag values, primitive content, boolean
and integer values, and child counts; build constructed structures such as
SEQUENCE and SET; append common primitive types
such as booleans, integers, big integers, bit strings, octets, OIDs, strings,
times, null values, and context-specific items; convert ASN.1 to XML; reload
from that XML form; and write the final structure back to DER.
Load DER data
BinData objects.
Inspect ASN.1 items
Build sequences and sets
SEQUENCE and SET items,
then add child ASN.1 values beneath them.
Append primitive values
Context-specific tags
DER and XML conversion
LoadBinary, LoadEncoded,
LoadBd, or LoadBinaryFile, inspect the tree with
Tag, Constructed, NumSubItems, and
GetSubItem, then extract primitive content or convert to XML
with AsnToXml. To create ASN.1, start with a constructed item,
append child values, and write the final DER with GetBinaryDer,
GetEncodedDer, WriteBd, or
WriteBinaryDer.
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 asn = try chilkat.Asn.init();
defer asn.deinit();Creates the underlying native Chilkat object. Asn 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.
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.
Wraps a handle obtained from the C API (chilkat.c.CkAsn), 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 = asn.someMethod(allocator, ...) catch |err| {
const why = try asn.getLastErrorText(allocator);
defer allocator.free(why);
std.debug.print("{s}\n", .{why});
return err;
};
defer allocator.free(text);Properties
BoolValue
pub fn getBoolValue(self: Asn) bool
pub fn setBoolValue(self: Asn, value: bool) void
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
pub fn getConstructed(self: Asn) bool
true if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive (non-constructed).
ContentStr
pub fn getContentStr(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
pub fn setContentStr(self: Asn, value: [:0]const u8) void
The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).
topDebugLogFilePath
pub fn getDebugLogFilePath(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: Asn, 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.
IntValue
pub fn getIntValue(self: Asn) i32
pub fn setIntValue(self: Asn, value: i32) void
The ASN.1 item's integer value if it is a small integer item.
topLastErrorHtml
pub fn getLastErrorHtml(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
pub fn getLastErrorText(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
pub fn getLastErrorXml(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
pub fn getLastMethodSuccess(self: Asn) bool
pub fn setLastMethodSuccess(self: Asn, value: bool) void
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumSubItems
pub fn getNumSubItems(self: Asn) i32
The number of sub-items contained within this ASN.1 item. Only constructed items, such as Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings, integers, etc. will never contain sub-items.
topTag
pub fn getTag(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
The ASN.1 item's tag as a descriptive string. Possible values are:
boolean integer bitString octets null oid utf8String relativeOid sequence set numericString printableString t61String ia5String utcTime bmpStringtop
TagValue
pub fn getTagValue(self: Asn) i32
The ASN.1 item's tag as a integer value. The integer values for possible tags are as follows:
boolean (1) integer (2) bitString (3) octets (4) null (5) oid (6) utf8String (12) relativeOid (13) sequence (16) set (17) numericString (18) printableString (19) t61String (20) ia5String (22) utcTime (23) bmpString (30)top
VerboseLogging
pub fn getVerboseLogging(self: Asn) bool
pub fn setVerboseLogging(self: Asn, value: bool) void
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
pub fn getVersion(self: Asn, allocator: Allocator) Allocator.Error![:0]u8
Methods
AppendBigInt
Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable. The bytes composing the integer are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendBits
Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB first). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendBool
Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendContextConstructed
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendContextPrimitive
Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendInt
Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendNull
Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendOctets
Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendOid
Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string form, such as 1.2.840.113549.1.9.1.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendSequence2
Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The returned object is owned by the caller: release it with deinit.
AppendSet
Appends an ASN.1 set item to the caller's sub-items.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendSet2
Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The returned object is owned by the caller: release it with deinit.
AppendString
Appends a string item to the caller's sub-items. The str_type specifies the type of string to be added. It may be utf8, ia5, t61, printable, visible, numeric, universal, or bmp. The value must conform to the ASN.1 restrictions imposed for a given string type. The utf8, bmp, and universal types have no restrictions on what characters are allowed. In general, unless a specific type of string is required, choose the utf8 type.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AppendTime
Appends a UTCTime item to the caller's sub-items. The time_format specifies the format of the date_time_str. It should be set to utc. (In the future, this method will be expanded to append GeneralizedTime items by using generalized for time_format.) To append the current date/time, set date_time_str equal to the empty string or the keyword now. Otherwise, the date_time_str should be in the UTC time format YYMMDDhhmm[ss]Z or YYMMDDhhmm[ss](+|-)hhmm.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
AsnToXml
Converts ASN.1 to XML and returns the XML string.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).
DeleteSubItem
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
GetEncodedContent
Returns the content of the ASN.1 item in encoded string form. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).
GetEncodedDer
Returns the binary DER in encoded string form. The encoding indicates the encoding and can be base64, hex, uu, quoted-printable, base32, or modbase64.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).
GetLastSubItem
Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The returned object is owned by the caller: release it with deinit.
GetSubItem
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The returned object is owned by the caller: release it with deinit.
LoadAsnXml
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
LoadBd
Loads ASN.1 from the binary DER contained in bd.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
LoadBinaryFile
Loads ASN.1 from a binary DER file.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
LoadEncoded
Loads ASN.1 from an encoded string. The encoding can be base64, hex, uu, quoted-printable, base32, or modbase64.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
SetEncodedContent
Sets the content of this primitive ASN.1 item. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
WriteBd
Appends the ASN.1 in binary DER format to bd.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
WriteBinaryDer
Writes the ASN.1 in binary DER form to a file.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.