AuthAzureSAS Xbase++ Reference Documentation
AuthAzureSAS
Current Version: 11.6.0
Chilkat.AuthAzureSAS
Generate a signed query-string token that authorizes limited access to an
Azure Storage resource.
Provide the exact Azure SAS string-to-sign required for the storage
service and resource being accessed.
Use the Azure Storage account access key to compute the signature placed
in the generated SAS token.
Add signed SAS parameters such as permissions, expiry, resource type, API
version, protocol, or IP restrictions.
Add query parameters that should accompany the request but should not be
included as part of the SAS token itself.
Use the generated SAS query string with Azure Storage requests built
using
For an extended overview, see
AuthAzureSAS Class Overview.
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
String-to-sign control
Account key signing
Token parameters
Non-token parameters
REST integration
Chilkat.Rest or other Chilkat HTTP workflows.
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
LOCAL oAuthAzureSAS
oAuthAzureSAS := CreateObject("Chilkat.AuthAzureSAS")
// ... use oAuthAzureSAS ...
oAuthAzureSAS:destroy()Xbase++ uses the Chilkat ActiveX through the automation object returned by CreateObject(); properties and methods are accessed with the send operator (oHttp:ConnectTimeout := 30, oHttp:Download(cUrl, cPath)), and :destroy() releases the object. Register the Chilkat ActiveX matching the bitness of your Xbase++ application. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as CreateObject("Chilkat.AuthAzureSAS.11") for Chilkat v11.*.*.
Boolean properties, arguments and return values are integers in the ActiveX: pass 1 or 0, and test a method's success with == 1. A method that fails to return an object returns NIL. Objects returned by methods (such as an HttpResponse or JsonObject) are automation objects too and should likewise be released with :destroy(). Methods and properties that pass or return raw byte arrays are not shown on this page; use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead.
Properties
AccessKey
This is the signing key (access key) that must be kept private. It is a base64 string such as abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw==
DebugLogFilePath
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
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
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
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
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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topStringToSign
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+ rsct
VerboseLogging
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
Methods
Clear
Clears all params set by the methods SetNonTokenParam and SetTokenParam.
topGenerateToken
Generates and returns the SAS token based on the defined StringToSign and params.
Returns NIL on 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 in the token query params.
Returns 1 for success, 0 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 in the token query params.
Returns 1 for success, 0 for failure.