CkAuthAzureSASW Unicode C++ Reference Documentation

CkAuthAzureSASW

Current Version: 10.1.0
Requires Chilkat Bundle License

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

This class is introduced in Chilkat v9.5.0.65.

Object Creation

// Local variable on the stack
CkAuthAzureSASW obj;

// Dynamically allocate/delete
CkAuthAzureSASW *pObj = new CkAuthAzureSASW();
// ...
delete pObj;

Properties

AccessKey
void get_AccessKey(CkString &str);
const wchar_t *accessKey(void);
void put_AccessKey(const wchar_t *str);
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
void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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 get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

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 get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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 get_StringToSign(CkString &str);
const wchar_t *stringToSign(void);
void put_StringToSign(const wchar_t *str);
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
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(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 get_Version(CkString &str);
const wchar_t *version(void);

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

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

Methods

Clear
void Clear(void);
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 GenerateToken(CkString &outStr);
const wchar_t *generateToken(void);
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.

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)Create an Azure Service SASUse an Azure Service SAS
top
SetNonTokenParam
bool SetNonTokenParam(const wchar_t *name, const wchar_t *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 SetTokenParam(const wchar_t *name, const wchar_t *authParamName, const wchar_t *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.

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