AuthAws Tcl Reference Documentation

AuthAws

Current Version: 9.5.0.75

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

Object Creation

set myAuthAws [new CkAuthAws]

Properties

AccessKey
string
# ckStr is a CkString
CkAuthAws_get_AccessKey $myAuthAws $ckStr
set strVal [CkAuthAws_get_accessKey $myAuthAws]
CkAuthAws_put_AccessKey $myAuthAws $strVal
Introduced in version 9.5.0.58

The AWS access key.

top
CanonicalizedResourceV2
string
# ckStr is a CkString
CkAuthAws_get_CanonicalizedResourceV2 $myAuthAws $ckStr
set strVal [CkAuthAws_get_canonicalizedResourceV2 $myAuthAws]
CkAuthAws_put_CanonicalizedResourceV2 $myAuthAws $strVal
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.

top
DebugLogFilePath
string
# ckStr is a CkString
CkAuthAws_get_DebugLogFilePath $myAuthAws $ckStr
set strVal [CkAuthAws_get_debugLogFilePath $myAuthAws]
CkAuthAws_put_DebugLogFilePath $myAuthAws $strVal

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.

top
LastErrorHtml
string
# ckStr is a CkString
CkAuthAws_get_LastErrorHtml $myAuthAws $ckStr
set strVal [CkAuthAws_get_lastErrorHtml $myAuthAws]

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.

top
LastErrorText
string
# ckStr is a CkString
CkAuthAws_get_LastErrorText $myAuthAws $ckStr
set strVal [CkAuthAws_get_lastErrorText $myAuthAws]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkAuthAws_get_LastErrorXml $myAuthAws $ckStr
set strVal [CkAuthAws_get_lastErrorXml $myAuthAws]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkAuthAws_get_LastMethodSuccess $myAuthAws]
CkAuthAws_put_LastMethodSuccess $myAuthAws $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
PrecomputedMd5
string
# ckStr is a CkString
CkAuthAws_get_PrecomputedMd5 $myAuthAws $ckStr
set strVal [CkAuthAws_get_precomputedMd5 $myAuthAws]
CkAuthAws_put_PrecomputedMd5 $myAuthAws $strVal
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.

top
PrecomputedSha256
string
# ckStr is a CkString
CkAuthAws_get_PrecomputedSha256 $myAuthAws $ckStr
set strVal [CkAuthAws_get_precomputedSha256 $myAuthAws]
CkAuthAws_put_PrecomputedSha256 $myAuthAws $strVal
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)

More Information and Examples
top
Region
string
# ckStr is a CkString
CkAuthAws_get_Region $myAuthAws $ckStr
set strVal [CkAuthAws_get_region $myAuthAws]
CkAuthAws_put_Region $myAuthAws $strVal
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.

top
SecretKey
string
# ckStr is a CkString
CkAuthAws_get_SecretKey $myAuthAws $ckStr
set strVal [CkAuthAws_get_secretKey $myAuthAws]
CkAuthAws_put_SecretKey $myAuthAws $strVal
Introduced in version 9.5.0.58

The AWS secret key.

top
ServiceName
string
# ckStr is a CkString
CkAuthAws_get_ServiceName $myAuthAws $ckStr
set strVal [CkAuthAws_get_serviceName $myAuthAws]
CkAuthAws_put_ServiceName $myAuthAws $strVal
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.

top
SignatureVersion
integer
set intVal [CkAuthAws_get_SignatureVersion $myAuthAws]
CkAuthAws_put_SignatureVersion $myAuthAws $intVal
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.

top
Utf8
boolean 1/0
set boolVal [CkAuthAws_get_Utf8 $myAuthAws]
CkAuthAws_put_Utf8 $myAuthAws $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkAuthAws_get_VerboseLogging $myAuthAws]
CkAuthAws_put_VerboseLogging $myAuthAws $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkAuthAws_get_Version $myAuthAws $ckStr
set strVal [CkAuthAws_get_version $myAuthAws]

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

top

Methods

SaveLastError
# path is a string
set status [CkAuthAws_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top