AuthUtil C Reference Documentation

AuthUtil

Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
Requires Chilkat Bundle License

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.

Create/Dispose

HCkAuthUtil instance = CkAuthUtil_Create();
// ...
CkAuthUtil_Dispose(instance);
HCkAuthUtil CkAuthUtil_Create(void);

Creates an instance of the HCkAuthUtil object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkAuthUtil_Dispose(HCkAuthUtil handle);

Objects created by calling CkAuthUtil_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAuthUtil_Dispose.

Properties

DebugLogFilePath
void CkAuthUtil_getDebugLogFilePath(HCkAuthUtil cHandle, HCkString retval);
void CkAuthUtil_putDebugLogFilePath(HCkAuthUtil cHandle, const char *newVal);
const char *CkAuthUtil_debugLogFilePath(HCkAuthUtil cHandle);

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
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
void CkAuthUtil_getLastErrorHtml(HCkAuthUtil cHandle, HCkString retval);
const char *CkAuthUtil_lastErrorHtml(HCkAuthUtil cHandle);

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
void CkAuthUtil_getLastErrorText(HCkAuthUtil cHandle, HCkString retval);
const char *CkAuthUtil_lastErrorText(HCkAuthUtil cHandle);

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void CkAuthUtil_getLastErrorXml(HCkAuthUtil cHandle, HCkString retval);
const char *CkAuthUtil_lastErrorXml(HCkAuthUtil cHandle);

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
BOOL CkAuthUtil_getLastMethodSuccess(HCkAuthUtil cHandle);
void CkAuthUtil_putLastMethodSuccess(HCkAuthUtil cHandle, BOOL newVal);

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
BOOL CkAuthUtil_getUtf8(HCkAuthUtil cHandle);
void CkAuthUtil_putUtf8(HCkAuthUtil cHandle, BOOL newVal);

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
BOOL CkAuthUtil_getVerboseLogging(HCkAuthUtil cHandle);
void CkAuthUtil_putVerboseLogging(HCkAuthUtil cHandle, BOOL newVal);

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
void CkAuthUtil_getVersion(HCkAuthUtil cHandle, HCkString retval);
const char *CkAuthUtil_version(HCkAuthUtil cHandle);

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

WalmartSignature
BOOL CkAuthUtil_WalmartSignature(HCkAuthUtil cHandle, const char *requestUrl, const char *consumerId, const char *privateKey, const char *requestMethod, HCkString outStr);
const char *CkAuthUtil_walmartSignature(HCkAuthUtil cHandle, const char *requestUrl, const char *consumerId, const char *privateKey, const char *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
Walmart - Get All Feed Statuses
top