OAuth1 C Reference Documentation
OAuth1
Current Version: 10.1.3
OAuth 1.0a signature generator.
Create/Dispose
HCkOAuth1 instance = CkOAuth1_Create(); // ... CkOAuth1_Dispose(instance);
Creates an instance of the HCkOAuth1 object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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
AuthorizationHeader
const char *CkOAuth1_authorizationHeader(HCkOAuth1 cHandle);
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.
topBaseString
const char *CkOAuth1_baseString(HCkOAuth1 cHandle);
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.
topConsumerKey
void CkOAuth1_putConsumerKey(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_consumerKey(HCkOAuth1 cHandle);
The consumer key.
topConsumerSecret
void CkOAuth1_putConsumerSecret(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_consumerSecret(HCkOAuth1 cHandle);
The consumer secret.
topDebugLogFilePath
void CkOAuth1_putDebugLogFilePath(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_debugLogFilePath(HCkOAuth1 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.
EncodedSignature
const char *CkOAuth1_encodedSignature(HCkOAuth1 cHandle);
The URL encoded representation of the Signature property
topGeneratedUrl
const char *CkOAuth1_generatedUrl(HCkOAuth1 cHandle);
The URL that includes the OAuth1 query params.
topHmacKey
const char *CkOAuth1_hmacKey(HCkOAuth1 cHandle);
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).
topLastErrorHtml
const char *CkOAuth1_lastErrorHtml(HCkOAuth1 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.
topLastErrorText
const char *CkOAuth1_lastErrorText(HCkOAuth1 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.
LastErrorXml
const char *CkOAuth1_lastErrorXml(HCkOAuth1 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.
topLastMethodSuccess
void CkOAuth1_putLastMethodSuccess(HCkOAuth1 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.
topNonce
void CkOAuth1_putNonce(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_nonce(HCkOAuth1 cHandle);
The nonce.
topOauthMethod
void CkOAuth1_putOauthMethod(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthMethod(HCkOAuth1 cHandle);
The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".
topOauthUrl
void CkOAuth1_putOauthUrl(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthUrl(HCkOAuth1 cHandle);
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=1Instead, set OAuthUrl equal to
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nland then subsequently call AddParam for each query parameter. top
OauthVersion
void CkOAuth1_putOauthVersion(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthVersion(HCkOAuth1 cHandle);
The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.
topQueryString
const char *CkOAuth1_queryString(HCkOAuth1 cHandle);
Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.
topRealm
void CkOAuth1_putRealm(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_realm(HCkOAuth1 cHandle);
The realm (optional).
topSignature
const char *CkOAuth1_signature(HCkOAuth1 cHandle);
The generated base64 signature.
topSignatureMethod
void CkOAuth1_putSignatureMethod(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_signatureMethod(HCkOAuth1 cHandle);
The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC-SHA256", "RSA-SHA1", and "RSA-SHA256" (or the equivalent "RSA-SHA2").
Timestamp
void CkOAuth1_putTimestamp(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_timestamp(HCkOAuth1 cHandle);
The timestamp, such as "1441632569".
topToken
void CkOAuth1_putToken(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_token(HCkOAuth1 cHandle);
The token.
topTokenSecret
void CkOAuth1_putTokenSecret(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_tokenSecret(HCkOAuth1 cHandle);
The token secret
topUncommonOptions
void CkOAuth1_putUncommonOptions(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_uncommonOptions(HCkOAuth1 cHandle);
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.
Utf8
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.
topVerboseLogging
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.
topVersion
const char *CkOAuth1_version(HCkOAuth1 cHandle);
Methods
AddParam
Adds an extra name/value parameter to the OAuth1 signature.
Returns TRUE for success, FALSE for failure.
Generate
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.
GenNonce
Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.
Returns TRUE for success, FALSE for failure.
topGenTimestamp
Sets the Timestamp property to the current date/time.
Returns TRUE for success, FALSE for failure.
topRemoveParam
Removes a name/value parameter from the OAuth1 signature.
Returns TRUE for success, FALSE for failure.
topSetRsaKey
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