AuthAzureSAS Tcl Reference Documentation

AuthAzureSAS

Current Version: 11.5.0

Chilkat.AuthAzureSAS

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.

Object Creation

# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkAuthAzureSAS]

Properties

AccessKey
string
# ckStr is a CkString
CkAuthAzureSAS_get_AccessKey $this $ckStr
set strVal [CkAuthAzureSAS_get_accessKey $this]
CkAuthAzureSAS_put_AccessKey $this $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==

top
DebugLogFilePath
string
# ckStr is a CkString
CkAuthAzureSAS_get_DebugLogFilePath $this $ckStr
set strVal [CkAuthAzureSAS_get_debugLogFilePath $this]
CkAuthAzureSAS_put_DebugLogFilePath $this $strVal

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.

More Information and Examples
top
LastErrorHtml
string
# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorHtml $this $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorHtml $this]

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.

top
LastErrorText
string
# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorText $this $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorText $this]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkAuthAzureSAS_get_LastErrorXml $this $ckStr
set strVal [CkAuthAzureSAS_get_lastErrorXml $this]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkAuthAzureSAS_get_LastMethodSuccess $this]
CkAuthAzureSAS_put_LastMethodSuccess $this $boolVal

Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
StringToSign
string
# ckStr is a CkString
CkAuthAzureSAS_get_StringToSign $this $ckStr
set strVal [CkAuthAzureSAS_get_stringToSign $this]
CkAuthAzureSAS_put_StringToSign $this $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 + <code>\n</code> +  
signedstart + <code>\n</code> +  
signedexpiry + <code>\n</code> +  
canonicalizedresource + <code>\n</code> +  
signedidentifier + <code>\n</code> +  
signedIP + <code>\n</code> +  
signedProtocol + <code>\n</code> +  
signedversion + <code>\n</code> +  
rscc + <code>\n</code> +  
rscd + <code>\n</code> +  
rsce + <code>\n</code> +  
rscl + <code>\n</code> +  
rsct

More Information and Examples
top
Utf8
boolean 1/0
set boolVal [CkAuthAzureSAS_get_Utf8 $this]
CkAuthAzureSAS_put_Utf8 $this $boolVal

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

top
VerboseLogging
boolean 1/0
set boolVal [CkAuthAzureSAS_get_VerboseLogging $this]
CkAuthAzureSAS_put_VerboseLogging $this $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.

top
Version
string
# ckStr is a CkString
CkAuthAzureSAS_get_Version $this $ckStr
set strVal [CkAuthAzureSAS_get_version $this]

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

More Information and Examples
top

Methods

Clear
set status [CkAuthAzureSAS_Clear $this]
Introduced in version 9.5.0.65

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

Returns 1 for success, 0 for failure.

top
GenerateToken
# outStr is a CkString (output)
set status [CkAuthAzureSAS_GenerateToken $this $outStr]
set retStr [CkAuthAzureSAS_generateToken $this]
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.

top
SetNonTokenParam
# name is a string
# value is a string
set status [CkAuthAzureSAS_SetNonTokenParam $this $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 in the token query params.

Returns 1 for success, 0 for failure.

top
SetTokenParam
# name is a string
# authParamName is a string
# value is a string
set status [CkAuthAzureSAS_SetTokenParam $this $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 in the token query params.

Returns 1 for success, 0 for failure.

top