---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: AuthAzureSAS
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkAuthAzureSASRef.html
---
# Chilkat AuthAzureSAS — C — v11.7.0

> Chilkat 11.7.0 · language=c · class=AuthAzureSAS
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/AuthAzureSAS.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/guide.md`.

## Purpose

**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](https://www.chilkatsoft.com/authazuresas_class_overview.asp).

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkAuthAzureSAS instance = CkAuthAzureSAS_Create();
// ...
CkAuthAzureSAS_Dispose(instance);
```

`HCkAuthAzureSAS CkAuthAzureSAS_Create(void);`

Creates an instance of the HCkAuthAzureSAS object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkAuthAzureSAS_Dispose(HCkAuthAzureSAS handle);`

Objects created by calling CkAuthAzureSAS_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAuthAzureSAS_Dispose.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in C.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `void CkAuthAzureSAS_getDebugLogFilePath(HCkAuthAzureSAS cHandle, HCkString retval); void CkAuthAzureSAS_putDebugLogFilePath(HCkAuthAzureSAS cHandle, const char *newVal); const char *CkAuthAzureSAS_debugLogFilePath(HCkAuthAzureSAS cHandle);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void CkAuthAzureSAS_getLastErrorHtml(HCkAuthAzureSAS cHandle, HCkString retval); const char *CkAuthAzureSAS_lastErrorHtml(HCkAuthAzureSAS cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkAuthAzureSAS_getLastErrorText(HCkAuthAzureSAS cHandle, HCkString retval); const char *CkAuthAzureSAS_lastErrorText(HCkAuthAzureSAS cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkAuthAzureSAS_getLastErrorXml(HCkAuthAzureSAS cHandle, HCkString retval); const char *CkAuthAzureSAS_lastErrorXml(HCkAuthAzureSAS cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkAuthAzureSAS_getLastMethodSuccess(HCkAuthAzureSAS cHandle); void CkAuthAzureSAS_putLastMethodSuccess(HCkAuthAzureSAS cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkAuthAzureSAS_getUtf8(HCkAuthAzureSAS cHandle); void CkAuthAzureSAS_putUtf8(HCkAuthAzureSAS cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkAuthAzureSAS_getVerboseLogging(HCkAuthAzureSAS cHandle); void CkAuthAzureSAS_putVerboseLogging(HCkAuthAzureSAS cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkAuthAzureSAS_getVersion(HCkAuthAzureSAS cHandle, HCkString retval); const char *CkAuthAzureSAS_version(HCkAuthAzureSAS cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessKey` | property, read/write | `void CkAuthAzureSAS_getAccessKey(HCkAuthAzureSAS cHandle, HCkString retval); void CkAuthAzureSAS_putAccessKey(HCkAuthAzureSAS cHandle, const char *newVal); const char *CkAuthAzureSAS_accessKey(HCkAuthAzureSAS cHandle);` |
| `StringToSign` | property, read/write | `void CkAuthAzureSAS_getStringToSign(HCkAuthAzureSAS cHandle, HCkString retval); void CkAuthAzureSAS_putStringToSign(HCkAuthAzureSAS cHandle, const char *newVal); const char *CkAuthAzureSAS_stringToSign(HCkAuthAzureSAS cHandle);` |
| `Clear` | method | `void CkAuthAzureSAS_Clear(HCkAuthAzureSAS cHandle);` |
| `GenerateToken` | method | `BOOL CkAuthAzureSAS_GenerateToken(HCkAuthAzureSAS cHandle, HCkString outStr); const char *CkAuthAzureSAS_generateToken(HCkAuthAzureSAS cHandle);` |
| `SetNonTokenParam` | method | `BOOL CkAuthAzureSAS_SetNonTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *value);` |
| `SetTokenParam` | method | `BOOL CkAuthAzureSAS_SetTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *authParamName, const char *value);` |

## Properties

### AuthAzureSAS.AccessKey

`Chilkat 11.7.0 · c · AuthAzureSAS · AccessKey · property · read/write · since 9.5.0.65`

```c
void CkAuthAzureSAS_getAccessKey(HCkAuthAzureSAS cHandle, HCkString retval);
void CkAuthAzureSAS_putAccessKey(HCkAuthAzureSAS cHandle, const char *newVal);
const char *CkAuthAzureSAS_accessKey(HCkAuthAzureSAS cHandle);
```

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

### AuthAzureSAS.StringToSign

`Chilkat 11.7.0 · c · AuthAzureSAS · StringToSign · property · read/write · since 9.5.0.65`

```c
void CkAuthAzureSAS_getStringToSign(HCkAuthAzureSAS cHandle, HCkString retval);
void CkAuthAzureSAS_putStringToSign(HCkAuthAzureSAS cHandle, const char *newVal);
const char *CkAuthAzureSAS_stringToSign(HCkAuthAzureSAS cHandle);
```

**Full documentation for this property (same in every language):** [Explaining Azure SAS Tokens](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/azure_sas_tokens_for_authentication.md)

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
```

## Methods

### AuthAzureSAS.Clear

`Chilkat 11.7.0 · c · AuthAzureSAS · Clear · method · since 9.5.0.65`

```c
void CkAuthAzureSAS_Clear(HCkAuthAzureSAS cHandle);
```

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

### AuthAzureSAS.GenerateToken

`Chilkat 11.7.0 · c · AuthAzureSAS · GenerateToken · method · since 9.5.0.65`

```c
BOOL CkAuthAzureSAS_GenerateToken(HCkAuthAzureSAS cHandle, HCkString outStr);
const char *CkAuthAzureSAS_generateToken(HCkAuthAzureSAS cHandle);
```

**Full documentation for this method (same in every language):** [Explaining Azure SAS Tokens](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/azure_sas_tokens_for_authentication.md)

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

Returns TRUE for success, FALSE for failure.

### AuthAzureSAS.SetNonTokenParam

`Chilkat 11.7.0 · c · AuthAzureSAS · SetNonTokenParam · method · since 9.5.0.65`

```c
BOOL CkAuthAzureSAS_SetNonTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *value);
```

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 TRUE for success, FALSE for failure.

### AuthAzureSAS.SetTokenParam

`Chilkat 11.7.0 · c · AuthAzureSAS · SetTokenParam · method · since 9.5.0.65`

```c
BOOL CkAuthAzureSAS_SetTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *authParamName, const char *value);
```

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 TRUE for success, FALSE for failure.

