AuthUtil CkPython Reference Documentation

CkAuthUtil

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

obj = chilkat.CkAuthUtil()

Properties

DebugLogFilePath
# strVal is a string
# ckStr is a CkString
authUtil.get_DebugLogFilePath(ckStr);
strVal = authUtil.debugLogFilePath();
authUtil.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.

More Information and Examples
top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
authUtil.get_LastErrorHtml(ckStr);
strVal = authUtil.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.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
authUtil.get_LastErrorText(ckStr);
strVal = authUtil.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.

top
LastErrorXml
# strVal is a string
# ckStr is a CkString
authUtil.get_LastErrorXml(ckStr);
strVal = authUtil.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.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = authUtil.get_LastMethodSuccess();
authUtil.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.

top
Utf8
# boolVal is a boolean
boolVal = authUtil.get_Utf8();
authUtil.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.

top
VerboseLogging
# boolVal is a boolean
boolVal = authUtil.get_VerboseLogging();
authUtil.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.

top
Version
# strVal is a string
# ckStr is a CkString
authUtil.get_Version(ckStr);
strVal = authUtil.version();

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

More Information and Examples
top

Methods

WalmartSignature
# requestUrl is a string
# consumerId is a string
# privateKey is a string
# requestMethod is a string
# outStr is a CkString (output)
status = authUtil.WalmartSignature(requestUrl, consumerId, privateKey, requestMethod, outStr);
retStr = authUtil.walmartSignature(requestUrl, consumerId, privateKey, requestMethod);
Introduced in version 9.5.0.67

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 True for success, False for failure.

More Information and Examples
top