AuthAzureSAS Tcl Reference Documentation

AuthAzureSAS

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

This class is introduced in Chilkat v9.5.0.65.

Object Creation

set myAuthAzureSAS [new CkAuthAzureSAS]

Properties

AccessKey (string)

# ckStr is a CkString
CkAuthAzureSAS_get_AccessKey $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_accessKey $myAuthAzureSAS]
CkAuthAzureSAS_put_AccessKey $myAuthAzureSAS $strVal

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=="

How to Generate an Azure Service Bus Shared Access Signature (SAS)

How to Generate an Azure Storage Account Shared Access Signature (SAS)

DebugLogFilePath (string)

# ckStr is a CkString
CkAuthAzureSAS_get_DebugLogFilePath $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_debugLogFilePath $myAuthAzureSAS]
CkAuthAzureSAS_put_DebugLogFilePath $myAuthAzureSAS $strVal

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.

LastErrorHtml (string)

# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorHtml $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorHtml $myAuthAzureSAS]

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.

LastErrorText (string)

# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorText $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorText $myAuthAzureSAS]

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml (string)

# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorXml $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorXml $myAuthAzureSAS]

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.

LastMethodSuccess (boolean 1/0)

set boolVal [CkAuthAzureSAS_get_LastMethodSuccess $myAuthAzureSAS]
CkAuthAzureSAS_put_LastMethodSuccess $myAuthAzureSAS $boolVal

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

StringToSign (string)

# ckStr is a CkString
CkAuthAzureSAS_get_StringToSign $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_stringToSign $myAuthAzureSAS]
CkAuthAzureSAS_put_StringToSign $myAuthAzureSAS $strVal

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

Utf8 (boolean 1/0)

set boolVal [CkAuthAzureSAS_get_Utf8 $myAuthAzureSAS]
CkAuthAzureSAS_put_Utf8 $myAuthAzureSAS $boolVal

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

VerboseLogging (boolean 1/0)

set boolVal [CkAuthAzureSAS_get_VerboseLogging $myAuthAzureSAS]
CkAuthAzureSAS_put_VerboseLogging $myAuthAzureSAS $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version (string)

# ckStr is a CkString
CkAuthAzureSAS_get_Version $myAuthAzureSAS $ckStr
set strVal [CkAuthAzureSAS_get_version $myAuthAzureSAS]

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

Methods

set status [CkAuthAzureSAS_Clear]

Introduced in version 9.5.0.65

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

Returns 1 for success, 0 for failure.

# outStr is a CkString (output)
set status [CkAuthAzureSAS_GenerateToken $outStr]
set retStr [CkAuthAzureSAS_generateToken $myAuthAzureSAS]

Introduced in version 9.5.0.65

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

Returns 1 for success, 0 for failure.

How to Generate an Azure Service Bus Shared Access Signature (SAS)

How to Generate an Azure Storage Account Shared Access Signature (SAS)

# path is a string
set status [CkAuthAzureSAS_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

# name is a string
# value is a string
set status [CkAuthAzureSAS_SetNonTokenParam $name $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 1 for success, 0 for failure.

# name is a string
# authParamName is a string
# value is a string
set status [CkAuthAzureSAS_SetTokenParam $name $authParamName $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 1 for success, 0 for failure.