AuthUtil Tcl Reference Documentation

AuthUtil

Current Version: 9.5.0.73

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
string
# 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, 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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
string
# ckStr is a CkString
CkAuthUtil_get_LastErrorHtml $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorHtml $myAuthUtil]

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.

top
LastErrorText
string
# ckStr is a CkString
CkAuthUtil_get_LastErrorText $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorText $myAuthUtil]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkAuthUtil_get_LastErrorXml $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_lastErrorXml $myAuthUtil]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkAuthUtil_get_LastMethodSuccess $myAuthUtil]
CkAuthUtil_put_LastMethodSuccess $myAuthUtil $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
boolean 1/0
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.

top
VerboseLogging
boolean 1/0
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.

top
Version
string
# ckStr is a CkString
CkAuthUtil_get_Version $myAuthUtil $ckStr
set strVal [CkAuthUtil_get_version $myAuthUtil]

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

top

Methods

SaveLastError
# path is a string
set status [CkAuthUtil_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
WalmartSignature
# requestUrl is a string
# 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]
Introduced in version 9.5.0.67

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.

More Information and Examples
top