AuthAws Delphi DLL Reference Documentation

AuthAws

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

Create/Dispose

function CkAuthAws_Create: HCkAuthAws; stdcall;

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

procedure CkAuthAws_Dispose(handle: HCkAuthAws); stdcall;

Objects created by calling CkAuthAws_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

procedure CkAuthAws_getAccessKey(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putAccessKey(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__accessKey(objHandle: HCkAuthAws): PWideChar; stdcall;

Introduced in version 9.5.0.58

The AWS access key.

procedure CkAuthAws_getCanonicalizedResourceV2(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putCanonicalizedResourceV2(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__canonicalizedResourceV2(objHandle: HCkAuthAws): PWideChar; stdcall;

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

procedure CkAuthAws_getDebugLogFilePath(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putDebugLogFilePath(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__debugLogFilePath(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

procedure CkAuthAws_getLastErrorHtml(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;

function CkAuthAws__lastErrorHtml(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

procedure CkAuthAws_getLastErrorText(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;

function CkAuthAws__lastErrorText(objHandle: HCkAuthAws): PWideChar; stdcall;

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

procedure CkAuthAws_getLastErrorXml(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;

function CkAuthAws__lastErrorXml(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

function CkAuthAws_getLastMethodSuccess(objHandle: HCkAuthAws): wordbool; stdcall;
procedure CkAuthAws_putLastMethodSuccess(objHandle: HCkAuthAws; newPropVal: wordbool); stdcall;

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.

procedure CkAuthAws_getPrecomputedMd5(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putPrecomputedMd5(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__precomputedMd5(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

procedure CkAuthAws_getPrecomputedSha256(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putPrecomputedSha256(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__precomputedSha256(objHandle: HCkAuthAws): PWideChar; stdcall;

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

procedure CkAuthAws_getRegion(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putRegion(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__region(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

procedure CkAuthAws_getSecretKey(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putSecretKey(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__secretKey(objHandle: HCkAuthAws): PWideChar; stdcall;

Introduced in version 9.5.0.58

The AWS secret key.

procedure CkAuthAws_getServiceName(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
procedure CkAuthAws_putServiceName(objHandle: HCkAuthAws; newPropVal: PWideChar); stdcall;

function CkAuthAws__serviceName(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

function CkAuthAws_getSignatureVersion(objHandle: HCkAuthAws): Integer; stdcall;
procedure CkAuthAws_putSignatureVersion(objHandle: HCkAuthAws; newPropVal: Integer); stdcall;

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.

function CkAuthAws_getVerboseLogging(objHandle: HCkAuthAws): wordbool; stdcall;
procedure CkAuthAws_putVerboseLogging(objHandle: HCkAuthAws; newPropVal: wordbool); stdcall;

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.

procedure CkAuthAws_getVersion(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;

function CkAuthAws__version(objHandle: HCkAuthAws): PWideChar; stdcall;

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

Methods

function CkAuthAws_SaveLastError(objHandle: HCkAuthAws;
    path: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.