AuthUtil Unicode C Reference Documentation

AuthUtil

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

HCkAuthUtilW CkAuthUtilW_Create(void);

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

void CkAuthUtilW_Dispose(HCkAuthUtilW handle);

Objects created by calling CkAuthUtilW_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 CkAuthUtilW_Dispose.

Properties

void CkAuthUtilW_getDebugLogFilePath(HCkAuthUtilW cHandle, HCkString retval);

void CkAuthUtilW_putDebugLogFilePath(HCkAuthUtilW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthUtilW_debugLogFilePath(HCkAuthUtilW cHandle);

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.

void CkAuthUtilW_getLastErrorHtml(HCkAuthUtilW cHandle, HCkString retval);

const wchar_t *CkAuthUtilW_lastErrorHtml(HCkAuthUtilW cHandle);

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.

void CkAuthUtilW_getLastErrorText(HCkAuthUtilW cHandle, HCkString retval);

const wchar_t *CkAuthUtilW_lastErrorText(HCkAuthUtilW cHandle);

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.

Concept of LastErrorText

LastErrorText Standard Information

void CkAuthUtilW_getLastErrorXml(HCkAuthUtilW cHandle, HCkString retval);

const wchar_t *CkAuthUtilW_lastErrorXml(HCkAuthUtilW cHandle);

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.

BOOL CkAuthUtilW_getLastMethodSuccess(HCkAuthUtilW cHandle);

void CkAuthUtilW_putLastMethodSuccess(HCkAuthUtilW cHandle, BOOL newVal);

Introduced in version 9.5.0.52

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.

BOOL CkAuthUtilW_getVerboseLogging(HCkAuthUtilW cHandle);

void CkAuthUtilW_putVerboseLogging(HCkAuthUtilW 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.

void CkAuthUtilW_getVersion(HCkAuthUtilW cHandle, HCkString retval);

const wchar_t *CkAuthUtilW_version(HCkAuthUtilW cHandle);

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

Methods

BOOL CkAuthUtilW_SaveLastError(HCkAuthUtilW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkAuthUtilW_WalmartSignature(HCkAuthUtilW cHandle, const wchar_t *requestUrl, const wchar_t *consumerId, const wchar_t *privateKey, const wchar_t *requestMethod, const wchar_t *outStr);

const wchar_t *CkAuthUtilW_walmartSignature(HCkAuthUtilW cHandle, const wchar_t *requestUrl, const wchar_t *consumerId, const wchar_t *privateKey, const wchar_t *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 TRUE for success, FALSE for failure.