OAuth1 Rust Reference Documentation

OAuth1

Current Version: 11.6.1

Chilkat.OAuth1

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

Generate the OAuth 1.0 signature and related authentication values from the HTTP method, request URL, credentials, token, nonce, and timestamp.

Authorization header

Produce the value to send in the HTTP Authorization header when OAuth parameters should be supplied as a header.

Signed URL output

Generate a URL that includes the OAuth 1.0 query parameters when the API expects authentication data in the request URL.

Extra signed parameters

Add or remove request-specific name/value parameters that must be included in the normalized parameter string and signature calculation.

HMAC or RSA signatures

Sign with HMAC-SHA1, HMAC-SHA256, RSA-SHA1, or RSA-SHA256, with RSA private keys supplied by SetRsaKey.

Debuggable signing details

Inspect the exact BaseString, HmacKey, QueryString, Signature, and EncodedSignature used to build the OAuth request.

Common pattern: Set 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.

URL guidance: Set 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

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::OAuth1;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let o_auth1 = OAuth1::new();
// ... the native object is freed when `o_auth1` goes out of scope.

pub fn new() -> OAuth1

Creates the underlying native Chilkat object (OAuth1 also implements Default). Every method takes &self, so the object never needs to be declared mut. A OAuth1 is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for OAuth1

The native object is freed when the OAuth1 is dropped — when it goes out of scope, or explicitly with drop(o_auth1). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<OAuth1>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match o_auth1.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

AuthorizationHeader

// read-only
pub fn authorization_header(&self) -> String

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.

OAuth1 Rust Reference Documentation

OAuth1

Current Version: 11.6.1

Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.

OAuth 1.0 signing

Authorization header

Signed URL output

Extra signed parameters

HMAC or RSA signatures

Debuggable signing details

Object Creation

Errors

Properties

AuthorizationHeader

BaseString

ConsumerKey

ConsumerSecret

DebugLogFilePath

EncodedSignature

GeneratedUrl

HmacKey

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Nonce

OauthMethod

OauthUrl

OauthVersion

QueryString

Realm

Signature

SignatureMethod

Timestamp

Token

TokenSecret

UncommonOptions

VerboseLogging

Version

Methods

AddParam

Generate

GenNonce

GenTimestamp

RemoveParam

SetRsaKey