CkAuthAzureSAS Ruby Reference Documentation
CkAuthAzureSAS
Current Version: 10.0.0
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.new()
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, 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.
LastErrorHtml
# ckStr is a CkString
authAzureSAS.get_LastErrorHtml(ckStr);
strVal = authAzureSAS.lastErrorHtml();
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.
topLastErrorText
# ckStr is a CkString
authAzureSAS.get_LastErrorText(ckStr);
strVal = authAzureSAS.lastErrorText();
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.
LastErrorXml
# ckStr is a CkString
authAzureSAS.get_LastErrorXml(ckStr);
strVal = authAzureSAS.lastErrorXml();
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.
topLastMethodSuccess
boolVal = authAzureSAS.get_LastMethodSuccess();
authAzureSAS.put_LastMethodSuccess(boolVal);
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
# 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.