AuthAzureSAS Delphi DLL Reference Documentation
AuthAzureSAS
Current Version: 10.1.0
Provides general functionality for Azure Shared Access Signature (SAS) Authorization.
This class is introduced in Chilkat v9.5.0.65.
Create/Dispose
var myObject: HCkAuthAzureSAS; begin myObject := CkAuthAzureSAS_Create(); // ... CkAuthAzureSAS_Dispose(myObject); end;
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.
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_putAccessKey(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__accessKey(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.
DebugLogFilePath
procedure CkAuthAzureSAS_putDebugLogFilePath(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__debugLogFilePath(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
See the notes about PWideChar memory ownership and validity.
LastErrorHtml
function CkAuthAzureSAS__lastErrorHtml(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkAuthAzureSAS__lastErrorText(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkAuthAzureSAS__lastErrorXml(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkAuthAzureSAS_putLastMethodSuccess(objHandle: HCkAuthAzureSAS; newPropVal: wordbool); stdcall;
Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
- 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topStringToSign
procedure CkAuthAzureSAS_putStringToSign(objHandle: HCkAuthAzureSAS; newPropVal: PWideChar); stdcall;
function CkAuthAzureSAS__stringToSign(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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
See the notes about PWideChar memory ownership and validity.
topVerboseLogging
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.
topVersion
function CkAuthAzureSAS__version(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
Version of the component/library, such as "9.5.0.94"
See the notes about PWideChar memory ownership and validity.
Methods
Clear
Clears all params set by the methods SetNonTokenParam and SetTokenParam.
Returns True for success, False for failure.
topGenerateToken
outStr: HCkString): wordbool; stdcall;
function CkAuthAzureSAS__generateToken(objHandle: HCkAuthAzureSAS): PWideChar; stdcall;
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.
SetNonTokenParam
name: PWideChar;
value: PWideChar): wordbool; stdcall;
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.
topSetTokenParam
name: PWideChar;
authParamName: PWideChar;
value: PWideChar): wordbool; stdcall;
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.