AuthAzureSAS Zig Reference Documentation

AuthAzureSAS

Current Version: 11.6.1
Requires Chilkat Bundle License

Chilkat.AuthAzureSAS

Create Azure Shared Access Signature tokens for signed Azure Storage requests.

Chilkat.AuthAzureSAS creates Azure Shared Access Signature authentication tokens. It defines the SAS string-to-sign, supplies the Azure Storage account access key used to compute the signature, and controls which parameters are included in the generated SAS token query string. The resulting token can be used with Chilkat.Rest, Chilkat.Http, or other request-building code that needs time-limited, permission-scoped access to Azure Storage resources.

SAS token generation

Generate a signed query-string token that authorizes limited access to an Azure Storage resource.

String-to-sign control

Provide the exact Azure SAS string-to-sign required for the storage service and resource being accessed.

Account key signing

Use the Azure Storage account access key to compute the signature placed in the generated SAS token.

Token parameters

Add signed SAS parameters such as permissions, expiry, resource type, API version, protocol, or IP restrictions.

Non-token parameters

Add query parameters that should accompany the request but should not be included as part of the SAS token itself.

REST integration

Use the generated SAS query string with Azure Storage requests built using Chilkat.Rest or other Chilkat HTTP workflows.

Common pattern: Create an AuthAzureSAS object, set the Azure Storage AccessKey, provide the required StringToSign, add SAS token parameters with SetTokenParam, add any extra query parameters with SetNonTokenParam, then call GenerateToken. Use AuthAzureSAS when you need a SAS query token; use Chilkat.AuthAzureStorage when you need Shared Key authorization headers instead.

For an extended overview, see AuthAzureSAS 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 auth_azure_sas = try chilkat.AuthAzureSAS.init();
defer auth_azure_sas.deinit();
pub fn init() Allocator.Error!AuthAzureSAS

Creates the underlying native Chilkat object. AuthAzureSAS 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: AuthAzureSAS) 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.CkAuthAzureSAS.HCkAuthAzureSAS) AuthAzureSAS

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

Properties

AccessKey
// read/write
pub fn getAccessKey(self: AuthAzureSAS, allocator: Allocator) Allocator.Error![:0]u8
pub fn setAccessKey(self: AuthAzureSAS, value: [:0]const u8) void
Introduced in version 9.5.0.65

This is the signing key (access key) that must be kept private. It is a base64 string such as abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw==

More Information and Examples
How to Generate an Azure Service Bus Shared Access Signature (SAS)How to Generate an Azure Storage Account Shared Access Signature (SAS)
top
DebugLogFilePath
// read/write
pub fn getDebugLogFilePath(self: AuthAzureSAS, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: AuthAzureSAS, 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.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
// read-only
pub fn getLastErrorHtml(self: AuthAzureSAS, 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.

top
LastErrorText
// read-only
pub fn getLastErrorText(self: AuthAzureSAS, 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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
// read-only
pub fn getLastErrorXml(self: AuthAzureSAS, 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.

top
LastMethodSuccess
// read/write
pub fn getLastMethodSuccess(self: AuthAzureSAS) bool
pub fn setLastMethodSuccess(self: AuthAzureSAS, 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.

top
StringToSign
// read/write
pub fn getStringToSign(self: AuthAzureSAS, allocator: Allocator) Allocator.Error![:0]u8
pub fn setStringToSign(self: AuthAzureSAS, value: [:0]const u8) void
Introduced in version 9.5.0.65

Defines the format of the string to sign.

The format is specified as a comma-separated list of names. For example:

signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct
This will result in an actual string-to-sign that is composed of the values for each name separated by newline (LF) chars. For example: 
signedpermissions + \n +  
signedstart + \n +  
signedexpiry + \n +  
canonicalizedresource + \n +  
signedidentifier + \n +  
signedIP + \n +  
signedProtocol + \n +  
signedversion + \n +  
rscc + \n +  
rscd + \n +  
rsce + \n +  
rscl + \n +  
rsct

More Information and Examples
Explaining Azure SAS Tokens
top
VerboseLogging
// read/write
pub fn getVerboseLogging(self: AuthAzureSAS) bool
pub fn setVerboseLogging(self: AuthAzureSAS, 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.

top
Version
// read-only
pub fn getVersion(self: AuthAzureSAS, allocator: Allocator) Allocator.Error![:0]u8

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

Clear
pub fn clear(self: AuthAzureSAS) void
Introduced in version 9.5.0.65

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

top
GenerateToken
pub fn generateToken(self: AuthAzureSAS, allocator: Allocator) (Error || Allocator.Error)![:0]u8
Introduced in version 9.5.0.65

Generates and returns the SAS token based on the defined StringToSign and params.

Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).

More Information and Examples
Explaining Azure SAS TokensHow to Generate an Azure Service Bus Shared Access Signature (SAS)How to Generate an Azure Storage Account Shared Access Signature (SAS)Create an Azure Service SASUse an Azure Service SAS
top
SetNonTokenParam
pub fn setNonTokenParam(self: AuthAzureSAS, name: [:0]const u8, value: [:0]const u8) Error!void
Introduced in version 9.5.0.65

Adds a non-token parameter name/value. This is a value that is included in the string to sign, but is NOT included in the token query params.

Returns error.ChilkatFailed on failure; getLastErrorText explains why.

top
SetTokenParam
pub fn setTokenParam(self: AuthAzureSAS, name: [:0]const u8, auth_param_name: [:0]const u8, value: [:0]const u8) Error!void
Introduced in version 9.5.0.65

Adds a token parameter name/value. This is a value that is included in the string to sign, and is also included in the token query params.

Returns error.ChilkatFailed on failure; getLastErrorText explains why.

More Information and Examples
Create an Azure Service SASUse an Azure Service SAS
top