AuthAzureSAS Delphi DLL Reference Documentation

AuthAzureSAS

Current Version: 11.5.0
Requires Chilkat Bundle License

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.

For an extended overview, see AuthAzureSAS Class Overview.

Create/Dispose

var
myObject: HCkAuthAzureSAS;

begin
myObject := CkAuthAzureSAS_Create();

// ...

CkAuthAzureSAS_Dispose(myObject);
end;
function CkAuthAzureSAS_Create: HCkAuthAzureSAS; stdcall;

Creates an instance of the HCkAuthAzureSAS object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkAuthAzureSAS_Dispose(handle: HCkAuthAzureSAS); stdcall;

Objects created by calling CkAuthAzureSAS_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AccessKey
procedure CkAuthAzureSAS_getAccessKey(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
procedure CkAuthAzureSAS_putAccessKey(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__accessKey(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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==

See the notes about PWideChar memory ownership and validity.

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
procedure CkAuthAzureSAS_getDebugLogFilePath(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
procedure CkAuthAzureSAS_putDebugLogFilePath(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__debugLogFilePath(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
procedure CkAuthAzureSAS_getLastErrorHtml(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
function CkAuthAzureSAS__lastErrorHtml(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

top
LastErrorText
procedure CkAuthAzureSAS_getLastErrorText(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
function CkAuthAzureSAS__lastErrorText(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
procedure CkAuthAzureSAS_getLastErrorXml(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
function CkAuthAzureSAS__lastErrorXml(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

top
LastMethodSuccess
function CkAuthAzureSAS_getLastMethodSuccess(objHandle: HCkAuthAzureSAS): wordbool; stdcall;
procedure CkAuthAzureSAS_putLastMethodSuccess(objHandle: HCkAuthAzureSAS; newPropVal: wordbool); stdcall;

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. 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
procedure CkAuthAzureSAS_getStringToSign(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
procedure CkAuthAzureSAS_putStringToSign(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__stringToSign(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Explaining Azure SAS Tokens
top
VerboseLogging
function CkAuthAzureSAS_getVerboseLogging(objHandle: HCkAuthAzureSAS): wordbool; stdcall;
procedure CkAuthAzureSAS_putVerboseLogging(objHandle: HCkAuthAzureSAS; newPropVal: wordbool); stdcall;

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
procedure CkAuthAzureSAS_getVersion(objHandle: HCkAuthAzureSAS; outPropVal: HCkString); stdcall;
function CkAuthAzureSAS__version(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

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

Methods

Clear
procedure CkAuthAzureSAS_Clear(objHandle: HCkAuthAzureSAS) stdcall;
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
function CkAuthAzureSAS_GenerateToken(objHandle: HCkAuthAzureSAS;
    outStr: HCkString): wordbool; stdcall;
function CkAuthAzureSAS__generateToken(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Explaining Azure SAS TokensHow 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
function CkAuthAzureSAS_SetNonTokenParam(objHandle: HCkAuthAzureSAS;
    name: PWideChar;
    value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
SetTokenParam
function CkAuthAzureSAS_SetTokenParam(objHandle: HCkAuthAzureSAS;
    name: PWideChar;
    authParamName: PWideChar;
    value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

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