AuthAzureSAS Unicode C Reference Documentation
AuthAzureSAS
Current Version: 10.1.2
Provides general functionality for Azure Shared Access Signature (SAS) Authorization.
This class is introduced in Chilkat v9.5.0.65.
Create/Dispose
HCkAuthAzureSASW instance = CkAuthAzureSASW_Create(); // ... CkAuthAzureSASW_Dispose(instance);
Creates an instance of the HCkAuthAzureSASW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkAuthAzureSASW_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 CkAuthAzureSASW_Dispose.
Properties
AccessKey
void CkAuthAzureSASW_putAccessKey(HCkAuthAzureSASW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureSASW_accessKey(HCkAuthAzureSASW cHandle);
This is the signing key (access key) that must be kept private. It is a base64 string such as "abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw=="
DebugLogFilePath
void CkAuthAzureSASW_putDebugLogFilePath(HCkAuthAzureSASW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureSASW_debugLogFilePath(HCkAuthAzureSASW cHandle);
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.
LastErrorHtml
const wchar_t *CkAuthAzureSASW_lastErrorHtml(HCkAuthAzureSASW cHandle);
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
const wchar_t *CkAuthAzureSASW_lastErrorText(HCkAuthAzureSASW cHandle);
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
const wchar_t *CkAuthAzureSASW_lastErrorXml(HCkAuthAzureSASW cHandle);
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
void CkAuthAzureSASW_putLastMethodSuccess(HCkAuthAzureSASW cHandle, BOOL newVal);
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.
topStringToSign
void CkAuthAzureSASW_putStringToSign(HCkAuthAzureSASW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureSASW_stringToSign(HCkAuthAzureSASW cHandle);
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,rsctThis 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" + rscttop
VerboseLogging
void CkAuthAzureSASW_putVerboseLogging(HCkAuthAzureSASW 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.
topVersion
const wchar_t *CkAuthAzureSASW_version(HCkAuthAzureSASW cHandle);
Methods
Clear
Clears all params set by the methods SetNonTokenParam and SetTokenParam.
Returns TRUE for success, FALSE for failure.
topGenerateToken
const wchar_t *CkAuthAzureSASW_generateToken(HCkAuthAzureSASW cHandle);
Generates and returns the SAS token based on the defined StringToSign and params.
Returns TRUE for success, FALSE for failure.
SetNonTokenParam
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.
topSetTokenParam
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.