AuthAzureSAS C Reference Documentation

AuthAzureSAS

Current Version: 9.5.0.75

Provides general functionality for Azure Shared Access Signature (SAS) Authorization.

This class is introduced in Chilkat v9.5.0.65.

Create/Dispose

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.

Properties

AccessKey
void CkAuthAzureSAS_getAccessKey(HCkAuthAzureSAS cHandle, HCkString retval);
void CkAuthAzureSAS_putAccessKey(HCkAuthAzureSAS cHandle, const char *newVal);
const char *CkAuthAzureSAS_accessKey(HCkAuthAzureSAS cHandle);
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=="

top
DebugLogFilePath
void CkAuthAzureSAS_getDebugLogFilePath(HCkAuthAzureSAS cHandle, HCkString retval);
void CkAuthAzureSAS_putDebugLogFilePath(HCkAuthAzureSAS cHandle, const char *newVal);
const char *CkAuthAzureSAS_debugLogFilePath(HCkAuthAzureSAS cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void CkAuthAzureSAS_getLastErrorHtml(HCkAuthAzureSAS cHandle, HCkString retval);
const char *CkAuthAzureSAS_lastErrorHtml(HCkAuthAzureSAS cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void CkAuthAzureSAS_getLastErrorText(HCkAuthAzureSAS cHandle, HCkString retval);
const char *CkAuthAzureSAS_lastErrorText(HCkAuthAzureSAS cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void CkAuthAzureSAS_getLastErrorXml(HCkAuthAzureSAS cHandle, HCkString retval);
const char *CkAuthAzureSAS_lastErrorXml(HCkAuthAzureSAS cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkAuthAzureSAS_getLastMethodSuccess(HCkAuthAzureSAS cHandle);
void CkAuthAzureSAS_putLastMethodSuccess(HCkAuthAzureSAS cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
StringToSign
void CkAuthAzureSAS_getStringToSign(HCkAuthAzureSAS cHandle, HCkString retval);
void CkAuthAzureSAS_putStringToSign(HCkAuthAzureSAS cHandle, const char *newVal);
const char *CkAuthAzureSAS_stringToSign(HCkAuthAzureSAS cHandle);
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

top
Utf8
BOOL CkAuthAzureSAS_getUtf8(HCkAuthAzureSAS cHandle);
void CkAuthAzureSAS_putUtf8(HCkAuthAzureSAS cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkAuthAzureSAS_getVerboseLogging(HCkAuthAzureSAS cHandle);
void CkAuthAzureSAS_putVerboseLogging(HCkAuthAzureSAS cHandle, BOOL newVal);

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
void CkAuthAzureSAS_getVersion(HCkAuthAzureSAS cHandle, HCkString retval);
const char *CkAuthAzureSAS_version(HCkAuthAzureSAS cHandle);

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

top

Methods

Clear
void CkAuthAzureSAS_Clear(HCkAuthAzureSAS cHandle);
Introduced in version 9.5.0.65

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

Returns TRUE for success, FALSE for failure.

top
GenerateToken
BOOL CkAuthAzureSAS_GenerateToken(HCkAuthAzureSAS cHandle, HCkString outStr);
const char *CkAuthAzureSAS_generateToken(HCkAuthAzureSAS cHandle);
Introduced in version 9.5.0.65

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

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkAuthAzureSAS_SaveLastError(HCkAuthAzureSAS cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top
SetNonTokenParam
BOOL CkAuthAzureSAS_SetNonTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *value);
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 as a parameter in the Authorization header.

Returns TRUE for success, FALSE for failure.

top
SetTokenParam
BOOL CkAuthAzureSAS_SetTokenParam(HCkAuthAzureSAS cHandle, const char *name, const char *authParamName, const char *value);
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 as a parameter in the Authorization header.

Returns TRUE for success, FALSE for failure.

top