OAuth1 PHP Extension Reference Documentation
CkOAuth1
Current Version: 10.1.2
OAuth 1.0a signature generator.
Object Creation
$obj = new CkOAuth1();
Properties
AuthorizationHeader
string 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
string 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
void put_ConsumerKey(string strVal);
The consumer key.
topConsumerSecret
void put_ConsumerSecret(string strVal);
The consumer secret.
topDebugLogFilePath
void put_DebugLogFilePath(string 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
string encodedSignature();
The URL encoded representation of the Signature property
topGeneratedUrl
string generatedUrl();
The URL that includes the OAuth1 query params.
topHmacKey
string 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
string 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
string 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
string 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
void put_LastMethodSuccess(bool boolVal);
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 put_Nonce(string strVal);
The nonce.
topOauthMethod
void put_OauthMethod(string strVal);
The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".
topOauthUrl
void put_OauthUrl(string 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
void put_OauthVersion(string strVal);
The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.
topQueryString
string queryString();
Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.
topRealm
void put_Realm(string strVal);
The realm (optional).
topSignature
string signature();
The generated base64 signature.
topSignatureMethod
void put_SignatureMethod(string 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
void put_Timestamp(string strVal);
The timestamp, such as "1441632569".
topToken
void put_Token(string strVal);
The token.
topTokenSecret
void put_TokenSecret(string strVal);
The token secret
topUncommonOptions
void put_UncommonOptions(string 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
void put_Utf8(bool boolVal);
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 put_VerboseLogging(bool boolVal);
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
string version();
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