OAuth1 Tcl Reference Documentation

OAuth1

OAuth 1.0a signature generator.

Object Creation

set myOAuth1 [new CkOAuth1]

Properties

AuthorizationHeader (string)

# ckStr is a CkString
CkOAuth1_get_AuthorizationHeader $myOAuth1 $ckStr
set strVal [CkOAuth1_get_authorizationHeader $myOAuth1]

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 (string)

# ckStr is a CkString
CkOAuth1_get_BaseString $myOAuth1 $ckStr
set strVal [CkOAuth1_get_baseString $myOAuth1]

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 (string)

# ckStr is a CkString
CkOAuth1_get_ConsumerKey $myOAuth1 $ckStr
set strVal [CkOAuth1_get_consumerKey $myOAuth1]
CkOAuth1_put_ConsumerKey $myOAuth1 $strVal

Introduced in version 9.5.0.53

The consumer key.

ConsumerSecret (string)

# ckStr is a CkString
CkOAuth1_get_ConsumerSecret $myOAuth1 $ckStr
set strVal [CkOAuth1_get_consumerSecret $myOAuth1]
CkOAuth1_put_ConsumerSecret $myOAuth1 $strVal

Introduced in version 9.5.0.53

The consumer secret.

DebugLogFilePath (string)

# ckStr is a CkString
CkOAuth1_get_DebugLogFilePath $myOAuth1 $ckStr
set strVal [CkOAuth1_get_debugLogFilePath $myOAuth1]
CkOAuth1_put_DebugLogFilePath $myOAuth1 $strVal

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.

EncodedSignature (string)

# ckStr is a CkString
CkOAuth1_get_EncodedSignature $myOAuth1 $ckStr
set strVal [CkOAuth1_get_encodedSignature $myOAuth1]

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

GeneratedUrl (string)

# ckStr is a CkString
CkOAuth1_get_GeneratedUrl $myOAuth1 $ckStr
set strVal [CkOAuth1_get_generatedUrl $myOAuth1]

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

HmacKey (string)

# ckStr is a CkString
CkOAuth1_get_HmacKey $myOAuth1 $ckStr
set strVal [CkOAuth1_get_hmacKey $myOAuth1]

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 (string)

# ckStr is a CkString
CkOAuth1_get_LastErrorHtml $myOAuth1 $ckStr
set strVal [CkOAuth1_get_lastErrorHtml $myOAuth1]

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.

LastErrorText (string)

# ckStr is a CkString
CkOAuth1_get_LastErrorText $myOAuth1 $ckStr
set strVal [CkOAuth1_get_lastErrorText $myOAuth1]

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

LastErrorXml (string)

# ckStr is a CkString
CkOAuth1_get_LastErrorXml $myOAuth1 $ckStr
set strVal [CkOAuth1_get_lastErrorXml $myOAuth1]

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.

LastMethodSuccess (boolean 1/0)

set boolVal [CkOAuth1_get_LastMethodSuccess $myOAuth1]
CkOAuth1_put_LastMethodSuccess $myOAuth1 $boolVal

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Nonce (string)

# ckStr is a CkString
CkOAuth1_get_Nonce $myOAuth1 $ckStr
set strVal [CkOAuth1_get_nonce $myOAuth1]
CkOAuth1_put_Nonce $myOAuth1 $strVal

Introduced in version 9.5.0.53

The nonce.

OauthMethod (string)

# ckStr is a CkString
CkOAuth1_get_OauthMethod $myOAuth1 $ckStr
set strVal [CkOAuth1_get_oauthMethod $myOAuth1]
CkOAuth1_put_OauthMethod $myOAuth1 $strVal

Introduced in version 9.5.0.53

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

OauthUrl (string)

# ckStr is a CkString
CkOAuth1_get_OauthUrl $myOAuth1 $ckStr
set strVal [CkOAuth1_get_oauthUrl $myOAuth1]
CkOAuth1_put_OauthUrl $myOAuth1 $strVal

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 (string)

# ckStr is a CkString
CkOAuth1_get_OauthVersion $myOAuth1 $ckStr
set strVal [CkOAuth1_get_oauthVersion $myOAuth1]
CkOAuth1_put_OauthVersion $myOAuth1 $strVal

Introduced in version 9.5.0.53

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

QueryString (string)

# ckStr is a CkString
CkOAuth1_get_QueryString $myOAuth1 $ckStr
set strVal [CkOAuth1_get_queryString $myOAuth1]

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 (string)

# ckStr is a CkString
CkOAuth1_get_Realm $myOAuth1 $ckStr
set strVal [CkOAuth1_get_realm $myOAuth1]
CkOAuth1_put_Realm $myOAuth1 $strVal

Introduced in version 9.5.0.70

The realm (optional).

Signature (string)

# ckStr is a CkString
CkOAuth1_get_Signature $myOAuth1 $ckStr
set strVal [CkOAuth1_get_signature $myOAuth1]

Introduced in version 9.5.0.53

The generated base64 signature.

SignatureMethod (string)

# ckStr is a CkString
CkOAuth1_get_SignatureMethod $myOAuth1 $ckStr
set strVal [CkOAuth1_get_signatureMethod $myOAuth1]
CkOAuth1_put_SignatureMethod $myOAuth1 $strVal

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

Timestamp (string)

# ckStr is a CkString
CkOAuth1_get_Timestamp $myOAuth1 $ckStr
set strVal [CkOAuth1_get_timestamp $myOAuth1]
CkOAuth1_put_Timestamp $myOAuth1 $strVal

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

Token (string)

# ckStr is a CkString
CkOAuth1_get_Token $myOAuth1 $ckStr
set strVal [CkOAuth1_get_token $myOAuth1]
CkOAuth1_put_Token $myOAuth1 $strVal

Introduced in version 9.5.0.53

The token.

TokenSecret (string)

# ckStr is a CkString
CkOAuth1_get_TokenSecret $myOAuth1 $ckStr
set strVal [CkOAuth1_get_tokenSecret $myOAuth1]
CkOAuth1_put_TokenSecret $myOAuth1 $strVal

Introduced in version 9.5.0.53

The token secret

Utf8 (boolean 1/0)

set boolVal [CkOAuth1_get_Utf8 $myOAuth1]
CkOAuth1_put_Utf8 $myOAuth1 $boolVal

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

VerboseLogging (boolean 1/0)

set boolVal [CkOAuth1_get_VerboseLogging $myOAuth1]
CkOAuth1_put_VerboseLogging $myOAuth1 $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version (string)

# ckStr is a CkString
CkOAuth1_get_Version $myOAuth1 $ckStr
set strVal [CkOAuth1_get_version $myOAuth1]

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

Methods

# name is a string
# value is a string
set status [CkOAuth1_AddParam $name $value]

Introduced in version 9.5.0.53

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

Returns 1 for success, 0 for failure.

REST OAuth1 with Params

set status [CkOAuth1_Generate]

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 1 for success, 0 for failure.

Generate OAuth 1.0 Signature

# numBytes is an integer
set status [CkOAuth1_GenNonce $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 1 for success, 0 for failure.

set status [CkOAuth1_GenTimestamp]

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns 1 for success, 0 for failure.

# name is a string
set status [CkOAuth1_RemoveParam $name]

Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns 1 for success, 0 for failure.

# path is a string
set status [CkOAuth1_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

# privKey is a CkPrivateKey
set status [CkOAuth1_SetRsaKey $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 1 for success, 0 for failure.