AuthAws Unicode C Reference Documentation
AuthAws
Current Version: 10.1.2
Implements AWS Signature V4 for signing and authenticating AWS REST requests.
Create/Dispose
HCkAuthAwsW instance = CkAuthAwsW_Create(); // ... CkAuthAwsW_Dispose(instance);
Creates an instance of the HCkAuthAwsW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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
AccessKey
void CkAuthAwsW_putAccessKey(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_accessKey(HCkAuthAwsW cHandle);
The AWS access key.
topCanonicalizedResourceV2
void CkAuthAwsW_putCanonicalizedResourceV2(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_canonicalizedResourceV2(HCkAuthAwsW cHandle);
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.
DebugLogFilePath
void CkAuthAwsW_putDebugLogFilePath(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_debugLogFilePath(HCkAuthAwsW cHandle);
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.
LastErrorHtml
const wchar_t *CkAuthAwsW_lastErrorHtml(HCkAuthAwsW cHandle);
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.
topLastErrorText
const wchar_t *CkAuthAwsW_lastErrorText(HCkAuthAwsW cHandle);
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.
LastErrorXml
const wchar_t *CkAuthAwsW_lastErrorXml(HCkAuthAwsW cHandle);
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.
topLastMethodSuccess
void CkAuthAwsW_putLastMethodSuccess(HCkAuthAwsW cHandle, BOOL newVal);
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.
topPrecomputedMd5
void CkAuthAwsW_putPrecomputedMd5(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_precomputedMd5(HCkAuthAwsW cHandle);
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.
topPrecomputedSha256
void CkAuthAwsW_putPrecomputedSha256(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_precomputedSha256(HCkAuthAwsW cHandle);
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)
Region
void CkAuthAwsW_putRegion(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_region(HCkAuthAwsW cHandle);
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.
topSecretKey
void CkAuthAwsW_putSecretKey(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_secretKey(HCkAuthAwsW cHandle);
The AWS secret key.
topServiceName
void CkAuthAwsW_putServiceName(HCkAuthAwsW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAwsW_serviceName(HCkAuthAwsW cHandle);
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.
topSignatureVersion
void CkAuthAwsW_putSignatureVersion(HCkAuthAwsW cHandle, int newVal);
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.
topVerboseLogging
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.
topVersion
const wchar_t *CkAuthAwsW_version(HCkAuthAwsW cHandle);
Methods
GenPresignedUrl
const wchar_t *CkAuthAwsW_genPresignedUrl(HCkAuthAwsW cHandle, const wchar_t *httpVerb, BOOL useHttps, const wchar_t *domain, const wchar_t *path, int numSecondsValid, const wchar_t *awsService);
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.
top