OAuth1 Dart Reference Documentation
CkOAuth1
Current Version: 11.6.1
Chilkat.OAuth1
Generate the OAuth 1.0 signature and related authentication values from
the HTTP method, request URL, credentials, token, nonce, and timestamp.
Produce the value to send in the HTTP
Generate a URL that includes the OAuth 1.0 query parameters when the API
expects authentication data in the request URL.
Add or remove request-specific name/value parameters that must be
included in the normalized parameter string and signature calculation.
Sign with
Inspect the exact Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.
Chilkat.OAuth1 builds the signed OAuth 1.0 authentication data
needed for APIs that still require OAuth 1.0 request signing. It can generate
the signature base string, HMAC key, signature, URL-encoded signature,
normalized signed parameter string, Authorization header, and generated URL
containing OAuth query parameters. It supports consumer credentials, access
tokens, nonce and timestamp generation, extra signed parameters, optional
realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.
OAuth 1.0 signing
Authorization header
Authorization header
when OAuth parameters should be supplied as a header.
Signed URL output
Extra signed parameters
HMAC or RSA signatures
HMAC-SHA1, HMAC-SHA256,
RSA-SHA1, or RSA-SHA256, with RSA private keys
supplied by SetRsaKey.
Debuggable signing details
BaseString, HmacKey,
QueryString, Signature, and
EncodedSignature used to build the OAuth request.
OauthMethod and OauthUrl, provide the consumer
key and secret, set any token and token secret, generate or assign
Nonce and Timestamp, add request parameters with
AddParam, then call Generate. Use
AuthorizationHeader when sending OAuth data in an HTTP header, or
GeneratedUrl when the signed OAuth parameters should be placed
in the URL.
OauthUrl to the base request URL without query parameters.
Add query parameters separately with AddParam so they are
included correctly in the OAuth 1.0 signature calculation.
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final oAuth1 = CkOAuth1();
// ... the native object is released when `oAuth1` is garbage collected, or now with oAuth1.dispose().Creates the underlying native Chilkat object. Use a CkOAuth1 only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
oAuth1.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkOAuth1.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
AuthorizationHeader
String get 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 get 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
String get consumerKey
set consumerKey(String value)
The consumer key.
topConsumerSecret
String get consumerSecret
set consumerSecret(String value)
The consumer secret.
topDebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
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 get encodedSignature
The URL encoded representation of the Signature property
topGeneratedUrl
String get generatedUrl
The URL that includes the OAuth1 query params.
topHmacKey
String get 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 get 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 get 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 get 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
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Nonce
String get nonce
set nonce(String value)
The nonce.
topOauthMethod
String get oauthMethod
set oauthMethod(String value)
The HTTP method, such as GET, POST, PUT, DELETE, or HEAD. Defaults to GET.
OauthUrl
String get oauthUrl
set oauthUrl(String value)
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
String get oauthVersion
set oauthVersion(String value)
The oauth_version. Defaults to 1.0. May be set to the empty string to exclude.
QueryString
String get queryString
Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.
topRealm
String get realm
set realm(String value)
The realm (optional).
topSignature
String get signature
The generated base64 signature.
topSignatureMethod
String get signatureMethod
set signatureMethod(String value)
The signature method. Defaults to HMAC-SHA1. Other possible choices are HMAC-SHA256, RSA-SHA1, and RSA-SHA256 (or the equivalent RSA-SHA2).
Timestamp
String get timestamp
set timestamp(String value)
The timestamp, such as 1441632569.
Token
String get token
set token(String value)
The token.
topTokenSecret
String get tokenSecret
set tokenSecret(String value)
The token secret
topUncommonOptions
String get uncommonOptions
set uncommonOptions(String value)
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.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
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.
Version
String get version
Methods
AddParam
Adds an extra name/value parameter to the OAuth1 signature.
Returns normally on success; throws a ChilkatException on 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 normally on success; throws a ChilkatException on failure.
GenNonce
Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.
Returns normally on success; throws a ChilkatException on failure.
GenTimestamp
Sets the Timestamp property to the current date/time.
Returns normally on success; throws a ChilkatException on failure.
RemoveParam
Removes a name/value parameter from the OAuth1 signature.
Returns normally on success; throws a ChilkatException on failure.
SetRsaKey
Sets the RSA key to be used when the SignatureMethod is set to RSA-SHA1 or RSA-SHA2.
Returns normally on success; throws a ChilkatException on failure.