AuthAzureSAS Node.js 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.

Object Creation

var obj = new chilkat.AuthAzureSAS();

Properties

AccessKey

· string

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

· string

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

Example showing how to use DebugLogFilePath.

top

LastErrorHtml

· string, read-only

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, read-only

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

top

LastErrorXml

· string, read-only

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

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.

top

StringToSign

· string

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

· boolean

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

· string, read-only

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

More Information and Examples

How to get the Chilkat version at runtime.

top

Methods

Clear

Clear();

· Does not return anything (returns Undefined).

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

var retStr = GenerateToken();

· Returns a String.

Introduced in version 9.5.0.65

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

Returns null on 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 SAS Use an Azure Service SAS

top

SetNonTokenParam

var status = SetNonTokenParam(name, value);

· Returns Boolean (true for success, false for failure).
· name String
· value String

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

var status = SetTokenParam(name, authParamName, value);

· Returns Boolean (true for success, false for failure).
· name String
· authParamName String
· value String

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 SAS Use an Azure Service SAS

top