CkAuthAwsW Unicode C++ Reference Documentation
Current Version: 220.127.116.11
Implements AWS Signature V4 for signing and authenticating AWS REST requests.
// Local variable on the stack CkAuthAwsW obj; // Dynamically allocate/delete CkAuthAwsW *pObj = new CkAuthAwsW(); // ... delete pObj;
const wchar_t *accessKey(void);
void put_AccessKey(const wchar_t *str);
The AWS access key.top
const wchar_t *canonicalizedResourceV2(void);
void put_CanonicalizedResourceV2(const wchar_t *str);
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.
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
const wchar_t *lastErrorHtml(void);
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
const wchar_t *lastErrorText(void);
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
const wchar_t *lastErrorXml(void);
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
void put_LastMethodSuccess(bool newVal);
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.top
const wchar_t *precomputedMd5(void);
void put_PrecomputedMd5(const wchar_t *str);
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
const wchar_t *precomputedSha256(void);
void put_PrecomputedSha256(const wchar_t *str);
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)
const wchar_t *region(void);
void put_Region(const wchar_t *str);
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
const wchar_t *secretKey(void);
void put_SecretKey(const wchar_t *str);
The AWS secret key.top
const wchar_t *serviceName(void);
void put_ServiceName(const wchar_t *str);
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
void put_SignatureVersion(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.top
void put_VerboseLogging(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.top
const wchar_t *version(void);
Version of the component/library, such as "18.104.22.168"top
const wchar_t *genPresignedUrl(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