AuthAws Unicode C Reference Documentation

AuthAws

Implements AWS Signature V4 for signing and authenticating AWS REST requests.

Create/Dispose

HCkAuthAwsW CkAuthAwsW_Create(void);

Creates an instance of the HCkAuthAwsW 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 CkAuthAwsW_Dispose(HCkAuthAwsW handle);

Objects created by calling CkAuthAwsW_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 CkAuthAwsW_Dispose.

Properties

void CkAuthAwsW_getAccessKey(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putAccessKey(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_accessKey(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

The AWS access key.

void CkAuthAwsW_getCanonicalizedResourceV2(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putCanonicalizedResourceV2(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_canonicalizedResourceV2(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

If AWS Signature Version V2 is used, then this property must be set. The rules for setting the canonicalized resource for the V2 signature method is described here: Constructing the CanonicalizedResource Element.

(using AWS Signature Version 2) Streaming Download to File

void CkAuthAwsW_getDebugLogFilePath(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putDebugLogFilePath(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_debugLogFilePath(HCkAuthAwsW 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 CkAuthAwsW_getLastErrorHtml(HCkAuthAwsW cHandle, HCkString retval);

const wchar_t *CkAuthAwsW_lastErrorHtml(HCkAuthAwsW 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 CkAuthAwsW_getLastErrorText(HCkAuthAwsW cHandle, HCkString retval);

const wchar_t *CkAuthAwsW_lastErrorText(HCkAuthAwsW 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 CkAuthAwsW_getLastErrorXml(HCkAuthAwsW cHandle, HCkString retval);

const wchar_t *CkAuthAwsW_lastErrorXml(HCkAuthAwsW 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 CkAuthAwsW_getLastMethodSuccess(HCkAuthAwsW cHandle);

void CkAuthAwsW_putLastMethodSuccess(HCkAuthAwsW 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.

void CkAuthAwsW_getPrecomputedMd5(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putPrecomputedMd5(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_precomputedMd5(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

This property can optionally be set for AWS requests that have a non-empty request body. This should be the base64 encoding of the 16 bytes of the MD5 hash. The most common need for this is if doing an S3 upload from a stream. (If the pre-computed MD5 is not provided, then Chilkat is forced to stream the entire file into memory so that it can calculate the MD5 for authentication.)

Note: AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses SHA256.

void CkAuthAwsW_getPrecomputedSha256(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putPrecomputedSha256(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_precomputedSha256(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

This property can optionally be set for AWS requests that have a non-empty request body. This should be the lowercase hex encoding of the 32-bytes of the SHA256 hash. The most common need for this is if doing an S3 upload from a stream. (If the pre-computed SHA-256 is not provided, then Chilkat is forced to stream the entire file into memory so that it can calculate the SHA-256 for authentication.)

Note: AWS Signature Version 4 uses the SHA256 hash. (AWS Signature Version 2 uses MD5)

AWS S3 File Streaming Upload

void CkAuthAwsW_getRegion(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putRegion(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_region(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

The AWS region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", etc. The default is "us-east-1". It is only used when the SignatureVersion property is set to 4. This property is unused when the SignatureVersion property is set to 2.

void CkAuthAwsW_getSecretKey(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putSecretKey(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_secretKey(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

The AWS secret key.

void CkAuthAwsW_getServiceName(HCkAuthAwsW cHandle, HCkString retval);

void CkAuthAwsW_putServiceName(HCkAuthAwsW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAwsW_serviceName(HCkAuthAwsW cHandle);

Introduced in version 9.5.0.58

The AWS service namespace, such as "s3", "ses", etc. See http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

This property is unused when the SignatureVersion property is set to 2.

int CkAuthAwsW_getSignatureVersion(HCkAuthAwsW cHandle);

void CkAuthAwsW_putSignatureVersion(HCkAuthAwsW cHandle, int newVal);

Introduced in version 9.5.0.58

The AWS Signature Version to be used in authentication. The default value is 4. This can optionally be set to the value 2 to use the older V2 signature version.

BOOL CkAuthAwsW_getVerboseLogging(HCkAuthAwsW cHandle);

void CkAuthAwsW_putVerboseLogging(HCkAuthAwsW 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 CkAuthAwsW_getVersion(HCkAuthAwsW cHandle, HCkString retval);

const wchar_t *CkAuthAwsW_version(HCkAuthAwsW cHandle);

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

Methods

BOOL CkAuthAwsW_SaveLastError(HCkAuthAwsW 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.