AuthAws Delphi DLL Reference Documentation

AuthAws

Current Version: 10.1.2

Requires Chilkat Bundle License

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

Create/Dispose

var
myObject: HCkAuthAws;

begin
myObject := CkAuthAws_Create();

// ...

CkAuthAws_Dispose(myObject);
end;

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

AccessKey

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.

See the notes about PWideChar memory ownership and validity.

CanonicalizedResourceV2

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

(using AWS Signature Version 2) Streaming Download to File

DebugLogFilePath

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, 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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkAuthAws_getLastErrorHtml(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
function CkAuthAws__lastErrorHtml(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkAuthAws_getLastErrorText(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
function CkAuthAws__lastErrorText(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkAuthAws_getLastErrorXml(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
function CkAuthAws__lastErrorXml(objHandle: HCkAuthAws): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

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

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.

PrecomputedMd5

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.

See the notes about PWideChar memory ownership and validity.

PrecomputedSha256

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)

See the notes about PWideChar memory ownership and validity.

More Information and Examples

AWS S3 File Streaming Upload

Region

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.

See the notes about PWideChar memory ownership and validity.

SecretKey

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.

See the notes about PWideChar memory ownership and validity.

ServiceName

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.

See the notes about PWideChar memory ownership and validity.

SignatureVersion

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.

VerboseLogging

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.

Version

procedure CkAuthAws_getVersion(objHandle: HCkAuthAws; outPropVal: HCkString); stdcall;
function CkAuthAws__version(objHandle: HCkAuthAws): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GenPresignedUrl

function CkAuthAws_GenPresignedUrl(objHandle: HCkAuthAws;
    httpVerb: PWideChar;
    useHttps: wordbool;
    domain: PWideChar;
    path: PWideChar;
    numSecondsValid: Integer;
    awsService: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkAuthAws__genPresignedUrl(objHandle: HCkAuthAws;
    httpVerb: PWideChar;
    useHttps: wordbool;
    domain: PWideChar;
    path: PWideChar;
    numSecondsValid: Integer;
    awsService: PWideChar): PWideChar; stdcall;

Introduced in version 9.5.0.85

Generates a temporary pre-signed URL for an Amazon AWS service using AWS Signature V4. Requires that the SecretKey, AccessKey, and Region properties be set to valid values prior to calling this method.

The URL that is generated has this format:

https://<domain>/<path>
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=<AccessKey>/<currentDate>/<Region>/<awsService>/aws4_request
&X-Amz-Date=<currentDateTime>
&X-Amz-Expires=<numSecondsValid>
&X-Amz-SignedHeaders=host
&X-Amz-Signature=<signature-value>

The httpVerb is the HTTP verb such as "GET", "PUT", "POST", "DELETE", etc. The awsService is a string naming the AWS service, such as "s3", "execute-api", etc. If useHttps is True, then the returned URL begins with "https://", otherwise it begins with "http://".

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.