OAuth1 C Reference Documentation

OAuth1

OAuth 1.0a signature generator.

Create/Dispose

HCkOAuth1 CkOAuth1_Create(void);

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

void CkOAuth1_Dispose(HCkOAuth1 handle);

Objects created by calling CkOAuth1_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 CkOAuth1_Dispose.

Properties

void CkOAuth1_getAuthorizationHeader(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_authorizationHeader(HCkOAuth1 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.

void CkOAuth1_getBaseString(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_baseString(HCkOAuth1 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.

void CkOAuth1_getConsumerKey(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putConsumerKey(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_consumerKey(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The consumer key.

void CkOAuth1_getConsumerSecret(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putConsumerSecret(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_consumerSecret(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The consumer secret.

void CkOAuth1_getDebugLogFilePath(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putDebugLogFilePath(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_debugLogFilePath(HCkOAuth1 cHandle);

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 CkOAuth1_getEncodedSignature(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_encodedSignature(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

void CkOAuth1_getGeneratedUrl(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_generatedUrl(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

void CkOAuth1_getHmacKey(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_hmacKey(HCkOAuth1 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).

void CkOAuth1_getLastErrorHtml(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_lastErrorHtml(HCkOAuth1 cHandle);

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 CkOAuth1_getLastErrorText(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_lastErrorText(HCkOAuth1 cHandle);

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 CkOAuth1_getLastErrorXml(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_lastErrorXml(HCkOAuth1 cHandle);

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 CkOAuth1_getLastMethodSuccess(HCkOAuth1 cHandle);

void CkOAuth1_putLastMethodSuccess(HCkOAuth1 cHandle, 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 CkOAuth1_getNonce(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putNonce(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_nonce(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The nonce.

void CkOAuth1_getOauthMethod(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putOauthMethod(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_oauthMethod(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

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

void CkOAuth1_getOauthUrl(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putOauthUrl(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_oauthUrl(HCkOAuth1 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.

void CkOAuth1_getOauthVersion(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putOauthVersion(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_oauthVersion(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

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

void CkOAuth1_getQueryString(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_queryString(HCkOAuth1 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.

void CkOAuth1_getRealm(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putRealm(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_realm(HCkOAuth1 cHandle);

Introduced in version 9.5.0.70

The realm (optional).

void CkOAuth1_getSignature(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_signature(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The generated base64 signature.

void CkOAuth1_getSignatureMethod(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putSignatureMethod(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_signatureMethod(HCkOAuth1 cHandle);

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 CkOAuth1_getTimestamp(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putTimestamp(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_timestamp(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

void CkOAuth1_getToken(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putToken(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_token(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The token.

void CkOAuth1_getTokenSecret(HCkOAuth1 cHandle, HCkString retval);

void CkOAuth1_putTokenSecret(HCkOAuth1 cHandle, const char *newVal);

const char *CkOAuth1_tokenSecret(HCkOAuth1 cHandle);

Introduced in version 9.5.0.53

The token secret

BOOL CkOAuth1_getUtf8(HCkOAuth1 cHandle);

void CkOAuth1_putUtf8(HCkOAuth1 cHandle, 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.

BOOL CkOAuth1_getVerboseLogging(HCkOAuth1 cHandle);

void CkOAuth1_putVerboseLogging(HCkOAuth1 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.

void CkOAuth1_getVersion(HCkOAuth1 cHandle, HCkString retval);

const char *CkOAuth1_version(HCkOAuth1 cHandle);

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

Methods

BOOL CkOAuth1_AddParam(HCkOAuth1 cHandle, 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.

REST OAuth1 with Params

BOOL CkOAuth1_Generate(HCkOAuth1 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.

Generate OAuth 1.0 Signature

BOOL CkOAuth1_GenNonce(HCkOAuth1 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.

BOOL CkOAuth1_GenTimestamp(HCkOAuth1 cHandle);

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns TRUE for success, FALSE for failure.

BOOL CkOAuth1_RemoveParam(HCkOAuth1 cHandle, 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.

BOOL CkOAuth1_SaveLastError(HCkOAuth1 cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkOAuth1_SetRsaKey(HCkOAuth1 cHandle, HCkPrivateKey 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.