CkOAuth1 C++ Reference Documentation

CkOAuth1

Current Version: 9.5.0.75

OAuth 1.0a signature generator.

Object Creation

// Local variable on the stack
CkOAuth1 obj;

// Dynamically allocate/delete
CkOAuth1 *pObj = new CkOAuth1();
// ...
delete pObj;

Properties

AuthorizationHeader
void get_AuthorizationHeader(CkString &str);
const char *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.

top
BaseString
void get_BaseString(CkString &str);
const char *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.

top
ConsumerKey
void get_ConsumerKey(CkString &str);
const char *consumerKey(void);
void put_ConsumerKey(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The consumer key.

top
ConsumerSecret
void get_ConsumerSecret(CkString &str);
const char *consumerSecret(void);
void put_ConsumerSecret(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The consumer secret.

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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
EncodedSignature
void get_EncodedSignature(CkString &str);
const char *encodedSignature(void);
Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

top
GeneratedUrl
void get_GeneratedUrl(CkString &str);
const char *generatedUrl(void);
Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

top
HmacKey
void get_HmacKey(CkString &str);
const char *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).

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *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
LastErrorText
void get_LastErrorText(CkString &str);
const char *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
LastErrorXml
void get_LastErrorXml(CkString &str);
const char *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
LastMethodSuccess
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.

top
Nonce
void get_Nonce(CkString &str);
const char *nonce(void);
void put_Nonce(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The nonce.

top
OauthMethod
void get_OauthMethod(CkString &str);
const char *oauthMethod(void);
void put_OauthMethod(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

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

top
OauthUrl
void get_OauthUrl(CkString &str);
const char *oauthUrl(void);
void put_OauthUrl(const char *ansiOrUtf8Str);
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.

top
OauthVersion
void get_OauthVersion(CkString &str);
const char *oauthVersion(void);
void put_OauthVersion(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

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

top
QueryString
void get_QueryString(CkString &str);
const char *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.

top
Realm
void get_Realm(CkString &str);
const char *realm(void);
void put_Realm(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.70

The realm (optional).

top
Signature
void get_Signature(CkString &str);
const char *signature(void);
Introduced in version 9.5.0.53

The generated base64 signature.

top
SignatureMethod
void get_SignatureMethod(CkString &str);
const char *signatureMethod(void);
void put_SignatureMethod(const char *ansiOrUtf8Str);
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".

top
Timestamp
void get_Timestamp(CkString &str);
const char *timestamp(void);
void put_Timestamp(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

top
Token
void get_Token(CkString &str);
const char *token(void);
void put_Token(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The token.

top
TokenSecret
void get_TokenSecret(CkString &str);
const char *tokenSecret(void);
void put_TokenSecret(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.53

The token secret

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

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

top
VerboseLogging
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.

top
Version
void get_Version(CkString &str);
const char *version(void);

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

top

Methods

AddParam
bool AddParam(const char *name, const char *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.

More Information and Examples
top
Generate
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.

More Information and Examples
top
GenNonce
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.

top
GenTimestamp
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.

top
RemoveParam
bool RemoveParam(const char *name);
Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns true for success, false for failure.

top
SaveLastError
bool SaveLastError(const char *path);

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

Returns true for success, false for failure.

top
SetRsaKey
bool SetRsaKey(CkPrivateKey &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.

top