OAuth1 Perl Reference Documentation
CkOAuth1
Current Version: 10.1.2
OAuth 1.0a signature generator.
Object Creation
$obj = chilkat::CkOAuth1->new();
Properties
AuthorizationHeader
# $ckStr is a CkString
$oAuth1->get_AuthorizationHeader($ckStr);
$strVal = $oAuth1->authorizationHeader();
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
# $ckStr is a CkString
$oAuth1->get_BaseString($ckStr);
$strVal = $oAuth1->baseString();
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
# $ckStr is a CkString
$oAuth1->get_ConsumerKey($ckStr);
$strVal = $oAuth1->consumerKey();
$oAuth1->put_ConsumerKey($strVal);
The consumer key.
topConsumerSecret
# $ckStr is a CkString
$oAuth1->get_ConsumerSecret($ckStr);
$strVal = $oAuth1->consumerSecret();
$oAuth1->put_ConsumerSecret($strVal);
The consumer secret.
topDebugLogFilePath
# $ckStr is a CkString
$oAuth1->get_DebugLogFilePath($ckStr);
$strVal = $oAuth1->debugLogFilePath();
$oAuth1->put_DebugLogFilePath($strVal);
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
# $ckStr is a CkString
$oAuth1->get_EncodedSignature($ckStr);
$strVal = $oAuth1->encodedSignature();
The URL encoded representation of the Signature property
topGeneratedUrl
# $ckStr is a CkString
$oAuth1->get_GeneratedUrl($ckStr);
$strVal = $oAuth1->generatedUrl();
The URL that includes the OAuth1 query params.
topHmacKey
# $ckStr is a CkString
$oAuth1->get_HmacKey($ckStr);
$strVal = $oAuth1->hmacKey();
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
# $ckStr is a CkString
$oAuth1->get_LastErrorHtml($ckStr);
$strVal = $oAuth1->lastErrorHtml();
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
# $ckStr is a CkString
$oAuth1->get_LastErrorText($ckStr);
$strVal = $oAuth1->lastErrorText();
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
# $ckStr is a CkString
$oAuth1->get_LastErrorXml($ckStr);
$strVal = $oAuth1->lastErrorXml();
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
$boolVal = $oAuth1->get_LastMethodSuccess();
$oAuth1->put_LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 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
# $ckStr is a CkString
$oAuth1->get_Nonce($ckStr);
$strVal = $oAuth1->nonce();
$oAuth1->put_Nonce($strVal);
The nonce.
topOauthMethod
# $ckStr is a CkString
$oAuth1->get_OauthMethod($ckStr);
$strVal = $oAuth1->oauthMethod();
$oAuth1->put_OauthMethod($strVal);
The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".
topOauthUrl
# $ckStr is a CkString
$oAuth1->get_OauthUrl($ckStr);
$strVal = $oAuth1->oauthUrl();
$oAuth1->put_OauthUrl($strVal);
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
# $ckStr is a CkString
$oAuth1->get_OauthVersion($ckStr);
$strVal = $oAuth1->oauthVersion();
$oAuth1->put_OauthVersion($strVal);
The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.
topQueryString
# $ckStr is a CkString
$oAuth1->get_QueryString($ckStr);
$strVal = $oAuth1->queryString();
Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.
topRealm
# $ckStr is a CkString
$oAuth1->get_Realm($ckStr);
$strVal = $oAuth1->realm();
$oAuth1->put_Realm($strVal);
The realm (optional).
topSignature
# $ckStr is a CkString
$oAuth1->get_Signature($ckStr);
$strVal = $oAuth1->signature();
The generated base64 signature.
topSignatureMethod
# $ckStr is a CkString
$oAuth1->get_SignatureMethod($ckStr);
$strVal = $oAuth1->signatureMethod();
$oAuth1->put_SignatureMethod($strVal);
The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC-SHA256", "RSA-SHA1", and "RSA-SHA256" (or the equivalent "RSA-SHA2").
Timestamp
# $ckStr is a CkString
$oAuth1->get_Timestamp($ckStr);
$strVal = $oAuth1->timestamp();
$oAuth1->put_Timestamp($strVal);
The timestamp, such as "1441632569".
topToken
# $ckStr is a CkString
$oAuth1->get_Token($ckStr);
$strVal = $oAuth1->token();
$oAuth1->put_Token($strVal);
The token.
topTokenSecret
# $ckStr is a CkString
$oAuth1->get_TokenSecret($ckStr);
$strVal = $oAuth1->tokenSecret();
$oAuth1->put_TokenSecret($strVal);
The token secret
topUncommonOptions
# $ckStr is a CkString
$oAuth1->get_UncommonOptions($ckStr);
$strVal = $oAuth1->uncommonOptions();
$oAuth1->put_UncommonOptions($strVal);
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
$boolVal = $oAuth1->get_Utf8();
$oAuth1->put_Utf8($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.
topVerboseLogging
$boolVal = $oAuth1->get_VerboseLogging();
$oAuth1->put_VerboseLogging($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.
topVersion
# $ckStr is a CkString
$oAuth1->get_Version($ckStr);
$strVal = $oAuth1->version();
Methods
AddParam
# $value is a string
$status = $oAuth1->AddParam($name, $value);
Adds an extra name/value parameter to the OAuth1 signature.
Returns 1 for success, 0 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 1 for success, 0 for failure.
GenNonce
$status = $oAuth1->GenNonce($numBytes);
Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.
Returns 1 for success, 0 for failure.
topGenTimestamp
RemoveParam
$status = $oAuth1->RemoveParam($name);
SetRsaKey
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.
top