AuthUtil Tcl Reference Documentation
AuthUtil
Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
The AuthUtil class is intended to contain methods to help with authentication for various services, as the need arises. For example, the Walmart REST API requires an RSA signature calculation and this class provides a method for it.
Object Creation
set myAuthUtil [new CkAuthUtil]
Properties
DebugLogFilePath
# ckStr is a CkString
CkAuthUtil_get_DebugLogFilePath $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_debugLogFilePath $myAuthUtil]
CkAuthUtil_put_DebugLogFilePath $myAuthUtil $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
CkAuthUtil_get_LastErrorHtml $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorHtml $myAuthUtil]
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
CkAuthUtil_get_LastErrorText $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorText $myAuthUtil]
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
CkAuthUtil_get_LastErrorXml $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorXml $myAuthUtil]
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
set boolVal [CkAuthUtil_get_LastMethodSuccess $myAuthUtil]
CkAuthUtil_put_LastMethodSuccess $myAuthUtil $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
topUtf8
set boolVal [CkAuthUtil_get_Utf8 $myAuthUtil]
CkAuthUtil_put_Utf8 $myAuthUtil $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkAuthUtil_get_VerboseLogging $myAuthUtil]
CkAuthUtil_put_VerboseLogging $myAuthUtil $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
CkAuthUtil_get_Version $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_version $myAuthUtil]
Methods
WalmartSignature
# consumerId is a string
# privateKey is a string
# requestMethod is a string
# outStr is a CkString (output)
set status [CkAuthUtil_WalmartSignature $requestUrl $consumerId $privateKey $requestMethod $outStr]
set retStr [CkAuthUtil_walmartSignature $myAuthUtil $requestUrl $consumerId $privateKey $requestMethod]
Note: The Walmart REST API no longer users signatures for authentication. OAuth is now used. This method is deprecated and should no longer be used.
Generates a Walmart authentication signature for Walmart REST API calls. Returns a JSON string that contains both the WM_SEC_AUTH_SIGNATURE and WM_SEC.TIMESTAMP.
Returns 1 for success, 0 for failure.