OAuth1 Unicode C Reference Documentation

OAuth1

Current Version: 10.1.2

Requires Chilkat Bundle License

OAuth 1.0a signature generator.

Create/Dispose

HCkOAuth1W instance = CkOAuth1W_Create();
// ...
CkOAuth1W_Dispose(instance);

HCkOAuth1W CkOAuth1W_Create(void);

Creates an instance of the HCkOAuth1W object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkOAuth1W_Dispose(HCkOAuth1W handle);

Objects created by calling CkOAuth1W_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 CkOAuth1W_Dispose.

Properties

AuthorizationHeader

void CkOAuth1W_getAuthorizationHeader(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_authorizationHeader(HCkOAuth1W cHandle);

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.

BaseString

void CkOAuth1W_getBaseString(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_baseString(HCkOAuth1W cHandle);

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.

ConsumerKey

void CkOAuth1W_getConsumerKey(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putConsumerKey(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_consumerKey(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The consumer key.

ConsumerSecret

void CkOAuth1W_getConsumerSecret(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putConsumerSecret(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_consumerSecret(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The consumer secret.

DebugLogFilePath

void CkOAuth1W_getDebugLogFilePath(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putDebugLogFilePath(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_debugLogFilePath(HCkOAuth1W 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.

More Information and Examples

Example showing how to use DebugLogFilePath.

EncodedSignature

void CkOAuth1W_getEncodedSignature(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_encodedSignature(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

GeneratedUrl

void CkOAuth1W_getGeneratedUrl(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_generatedUrl(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

HmacKey

void CkOAuth1W_getHmacKey(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_hmacKey(HCkOAuth1W cHandle);

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).

LastErrorHtml

void CkOAuth1W_getLastErrorHtml(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_lastErrorHtml(HCkOAuth1W 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.

LastErrorText

void CkOAuth1W_getLastErrorText(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_lastErrorText(HCkOAuth1W 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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkOAuth1W_getLastErrorXml(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_lastErrorXml(HCkOAuth1W 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.

LastMethodSuccess

BOOL CkOAuth1W_getLastMethodSuccess(HCkOAuth1W cHandle);
void CkOAuth1W_putLastMethodSuccess(HCkOAuth1W 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.

Nonce

void CkOAuth1W_getNonce(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putNonce(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_nonce(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The nonce.

OauthMethod

void CkOAuth1W_getOauthMethod(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putOauthMethod(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_oauthMethod(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

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

OauthUrl

void CkOAuth1W_getOauthUrl(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putOauthUrl(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_oauthUrl(HCkOAuth1W cHandle);

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.

OauthVersion

void CkOAuth1W_getOauthVersion(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putOauthVersion(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_oauthVersion(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

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

QueryString

void CkOAuth1W_getQueryString(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_queryString(HCkOAuth1W cHandle);

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.

Realm

void CkOAuth1W_getRealm(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putRealm(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_realm(HCkOAuth1W cHandle);

Introduced in version 9.5.0.70

The realm (optional).

Signature

void CkOAuth1W_getSignature(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_signature(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The generated base64 signature.

SignatureMethod

void CkOAuth1W_getSignatureMethod(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putSignatureMethod(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_signatureMethod(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC-SHA256", "RSA-SHA1", and "RSA-SHA256" (or the equivalent "RSA-SHA2").

More Information and Examples

Generate OAuth 1.0 Signature

Timestamp

void CkOAuth1W_getTimestamp(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putTimestamp(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_timestamp(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

Token

void CkOAuth1W_getToken(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putToken(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_token(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The token.

TokenSecret

void CkOAuth1W_getTokenSecret(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putTokenSecret(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_tokenSecret(HCkOAuth1W cHandle);

Introduced in version 9.5.0.53

The token secret

UncommonOptions

void CkOAuth1W_getUncommonOptions(HCkOAuth1W cHandle, HCkString retval);
void CkOAuth1W_putUncommonOptions(HCkOAuth1W cHandle, const wchar_t *newVal);
const wchar_t *CkOAuth1W_uncommonOptions(HCkOAuth1W cHandle);

Introduced in version 9.5.0.85

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Can be set to a list of the following comma separated keywords:

"INCLUDE_REALM" - Introduced in v9.5.0.85. Include the Realm in the signature calculation and outputs.

VerboseLogging

BOOL CkOAuth1W_getVerboseLogging(HCkOAuth1W cHandle);
void CkOAuth1W_putVerboseLogging(HCkOAuth1W 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.

Version

void CkOAuth1W_getVersion(HCkOAuth1W cHandle, HCkString retval);
const wchar_t *CkOAuth1W_version(HCkOAuth1W cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddParam

BOOL CkOAuth1W_AddParam(HCkOAuth1W cHandle, 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.

More Information and Examples

REST OAuth1 with Params

Generate

BOOL CkOAuth1W_Generate(HCkOAuth1W cHandle);

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

Generate OAuth 1.0 Signature

GenNonce

BOOL CkOAuth1W_GenNonce(HCkOAuth1W cHandle, 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.

GenTimestamp

BOOL CkOAuth1W_GenTimestamp(HCkOAuth1W cHandle);

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns TRUE for success, FALSE for failure.

RemoveParam

BOOL CkOAuth1W_RemoveParam(HCkOAuth1W cHandle, 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.

SetRsaKey

BOOL CkOAuth1W_SetRsaKey(HCkOAuth1W cHandle, HCkPrivateKeyW 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.