AuthAzureSAS CkPython Reference Documentation
CkAuthAzureSAS
Current Version: 10.1.3
Provides general functionality for Azure Shared Access Signature (SAS) Authorization.
This class is introduced in Chilkat v9.5.0.65.
Object Creation
obj = chilkat.CkAuthAzureSAS()
Properties
AccessKey
# ckStr is a CkString
authAzureSAS.get_AccessKey(ckStr);
strVal = authAzureSAS.accessKey();
authAzureSAS.put_AccessKey(strVal);
This is the signing key (access key) that must be kept private. It is a base64 string such as "abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw=="
DebugLogFilePath
# ckStr is a CkString
authAzureSAS.get_DebugLogFilePath(ckStr);
strVal = authAzureSAS.debugLogFilePath();
authAzureSAS.put_DebugLogFilePath(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.
LastErrorHtml
# ckStr is a CkString
authAzureSAS.get_LastErrorHtml(ckStr);
strVal = authAzureSAS.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
# ckStr is a CkString
authAzureSAS.get_LastErrorText(ckStr);
strVal = authAzureSAS.lastErrorText();
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
# ckStr is a CkString
authAzureSAS.get_LastErrorXml(ckStr);
strVal = authAzureSAS.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
boolVal = authAzureSAS.get_LastMethodSuccess();
authAzureSAS.put_LastMethodSuccess(boolVal);
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.
topStringToSign
# ckStr is a CkString
authAzureSAS.get_StringToSign(ckStr);
strVal = authAzureSAS.stringToSign();
authAzureSAS.put_StringToSign(strVal);
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" + rscttop
Utf8
boolVal = authAzureSAS.get_Utf8();
authAzureSAS.put_Utf8(boolVal);
When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = authAzureSAS.get_VerboseLogging();
authAzureSAS.put_VerboseLogging(boolVal);
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
# ckStr is a CkString
authAzureSAS.get_Version(ckStr);
strVal = authAzureSAS.version();
Methods
Clear
Clears all params set by the methods SetNonTokenParam and SetTokenParam.
Returns True for success, False for failure.
topGenerateToken
status = authAzureSAS.GenerateToken(outStr);
retStr = authAzureSAS.generateToken();
Generates and returns the SAS token based on the defined StringToSign and params.
Returns True for success, False for failure.
SetNonTokenParam
# value is a string
status = authAzureSAS.SetNonTokenParam(name, value);
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
# authParamName is a string
# value is a string
status = authAzureSAS.SetTokenParam(name, authParamName, value);
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.