OAuth1 Zig Reference Documentation

OAuth1

Current Version: 11.6.1

Chilkat.OAuth1

Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.

Chilkat.OAuth1 builds the signed OAuth 1.0 authentication data needed for APIs that still require OAuth 1.0 request signing. It can generate the signature base string, HMAC key, signature, URL-encoded signature, normalized signed parameter string, Authorization header, and generated URL containing OAuth query parameters. It supports consumer credentials, access tokens, nonce and timestamp generation, extra signed parameters, optional realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.

OAuth 1.0 signing

Generate the OAuth 1.0 signature and related authentication values from the HTTP method, request URL, credentials, token, nonce, and timestamp.

Authorization header

Produce the value to send in the HTTP Authorization header when OAuth parameters should be supplied as a header.

Signed URL output

Generate a URL that includes the OAuth 1.0 query parameters when the API expects authentication data in the request URL.

Extra signed parameters

Add or remove request-specific name/value parameters that must be included in the normalized parameter string and signature calculation.

HMAC or RSA signatures

Sign with HMAC-SHA1, HMAC-SHA256, RSA-SHA1, or RSA-SHA256, with RSA private keys supplied by SetRsaKey.

Debuggable signing details

Inspect the exact BaseString, HmacKey, QueryString, Signature, and EncodedSignature used to build the OAuth request.

Common pattern: Set OauthMethod and OauthUrl, provide the consumer key and secret, set any token and token secret, generate or assign Nonce and Timestamp, add request parameters with AddParam, then call Generate. Use AuthorizationHeader when sending OAuth data in an HTTP header, or GeneratedUrl when the signed OAuth parameters should be placed in the URL.

URL guidance: Set OauthUrl to the base request URL without query parameters. Add query parameters separately with AddParam so they are included correctly in the OAuth 1.0 signature calculation.

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

pub fn init() Allocator.Error!OAuth1

Creates the underlying native Chilkat object. OAuth1 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: OAuth1) 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.CkOAuth1.HCkOAuth1) OAuth1

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

Properties

AuthorizationHeader

// read-only
pub fn getAuthorizationHeader(self: OAuth1, allocator: Allocator) Allocator.Error![:0]u8

Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

OAuth1 Zig Reference Documentation

OAuth1

Current Version: 11.6.1

Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.

OAuth 1.0 signing

Authorization header

Signed URL output

Extra signed parameters

HMAC or RSA signatures

Debuggable signing details

Object Creation

Errors and memory

Properties

AuthorizationHeader

BaseString

ConsumerKey

ConsumerSecret

DebugLogFilePath

EncodedSignature

GeneratedUrl

HmacKey

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Nonce

OauthMethod

OauthUrl

OauthVersion

QueryString

Realm

Signature

SignatureMethod

Timestamp

Token

TokenSecret

UncommonOptions

VerboseLogging

Version

Methods

AddParam

Generate

GenNonce

GenTimestamp

RemoveParam

SetRsaKey