CkOAuth1W Unicode C++ Reference Documentation

CkOAuth1W

OAuth 1.0a signature generator.

Properties

void get_AuthorizationHeader(CkString &str);
const wchar_t *authorizationHeader(void);

Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

void get_BaseString(CkString &str);
const wchar_t *baseString(void);

Introduced in version 9.5.0.53

This is the exact string that was signed. For example, if the signature method is HMAC-SHA1, the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set the BaseString property. The BaseString is exposed as a property to allow for debugging and to see the exact string that is signed.

void get_ConsumerKey(CkString &str);
const wchar_t *consumerKey(void);
void put_ConsumerKey(const wchar_t *str);

Introduced in version 9.5.0.53

The consumer key.

void get_ConsumerSecret(CkString &str);
const wchar_t *consumerSecret(void);
void put_ConsumerSecret(const wchar_t *str);

Introduced in version 9.5.0.53

The consumer secret.

void get_DebugLogFilePath(CkString &str);
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:

  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.

void get_EncodedSignature(CkString &str);
const wchar_t *encodedSignature(void);

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

void get_GeneratedUrl(CkString &str);
const wchar_t *generatedUrl(void);

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

void get_HmacKey(CkString &str);
const wchar_t *hmacKey(void);

Introduced in version 9.5.0.53

The exact HMAC key used to sign the BaseString. An application does not directly set the HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it exists) and the token secret (if it exists).

void get_LastErrorHtml(CkString &str);
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.

void get_LastErrorText(CkString &str);
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.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString &str);
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.

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

void get_Nonce(CkString &str);
const wchar_t *nonce(void);
void put_Nonce(const wchar_t *str);

Introduced in version 9.5.0.53

The nonce.

void get_OauthMethod(CkString &str);
const wchar_t *oauthMethod(void);
void put_OauthMethod(const wchar_t *str);

Introduced in version 9.5.0.53

The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".

void get_OauthUrl(CkString &str);
const wchar_t *oauthUrl(void);
void put_OauthUrl(const wchar_t *str);

Introduced in version 9.5.0.53

The OAuth URL, such as "http://echo.lab.madgex.com/echo.ashx". See http://bettiolo.github.io/oauth-reference-page/ to compare Chilkat results with another tool's results.

Note: The OAuthUrl should not include query parameters. For example, do not set the OAuthUrl equal to

https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1
Instead, set OAuthUrl equal to
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl
and then subsequently call AddParam for each query parameter.

void get_OauthVersion(CkString &str);
const wchar_t *oauthVersion(void);
void put_OauthVersion(const wchar_t *str);

Introduced in version 9.5.0.53

The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.

void get_QueryString(CkString &str);
const wchar_t *queryString(void);

Introduced in version 9.5.0.53

Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.

void get_Realm(CkString &str);
const wchar_t *realm(void);
void put_Realm(const wchar_t *str);

Introduced in version 9.5.0.70

The realm (optional).

void get_Signature(CkString &str);
const wchar_t *signature(void);

Introduced in version 9.5.0.53

The generated base64 signature.

void get_SignatureMethod(CkString &str);
const wchar_t *signatureMethod(void);
void put_SignatureMethod(const wchar_t *str);

Introduced in version 9.5.0.53

The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC1-SHA256", "RSA-SHA1", and "RSA-SHA2".

void get_Timestamp(CkString &str);
const wchar_t *timestamp(void);
void put_Timestamp(const wchar_t *str);

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

void get_Token(CkString &str);
const wchar_t *token(void);
void put_Token(const wchar_t *str);

Introduced in version 9.5.0.53

The token.

void get_TokenSecret(CkString &str);
const wchar_t *tokenSecret(void);
void put_TokenSecret(const wchar_t *str);

Introduced in version 9.5.0.53

The token secret

bool get_VerboseLogging(void);
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.

void get_Version(CkString &str);
const wchar_t *version(void);

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

Methods

bool AddParam(const wchar_t *name, const wchar_t *value);

Introduced in version 9.5.0.53

Adds an extra name/value parameter to the OAuth1 signature.

Returns true for success, false for failure.

REST OAuth1 with Params

bool Generate(void);

Introduced in version 9.5.0.53

Generate the signature based on the property settings. Input properties are OauthVersion, OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp. Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature, QueryString, GeneratedUrl, andAuthorizationHeader.

Returns true for success, false for failure.

Generate OAuth 1.0 Signature

bool GenNonce(int numBytes);

Introduced in version 9.5.0.55

Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.

Returns true for success, false for failure.

bool GenTimestamp(void);

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns true for success, false for failure.

bool RemoveParam(const wchar_t *name);

Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns true for success, false for failure.

bool SaveLastError(const wchar_t *path);

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

Returns true for success, false for failure.

bool SetRsaKey(CkPrivateKeyW &privKey);

Introduced in version 9.5.0.64

Sets the RSA key to be used when the SignatureMethod is set to "RSA-SHA1" or "RSA-SHA2".

Returns true for success, false for failure.