Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
OAuth 1.0A Client Utilities
tag: 0.1.6

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
test
Readme.md
package.json

Readme.md

Overview

An OAuth 1.0A library for node.js. There are currently a handful of OAuth libraries but I choose to take a different route with how the API is used. The usage is really similar to simplegeo's python OAuth client. It extends the built-in http client which makes signing requests require two extra parameters. The only difference is that requests must have thier body (if present) and a signature provided, the client takes care of the rest. You are responsible for handling the authentication flow, check out this example to see possible uses.

Thanks to ciaranj for providing a place to start.

Installation

You can be fancy and clone the repo from here, or install npm and run:

npm install oauth-client

The include you must specify, if using the npm install:

require('oauth-client')

Otherwise:

require('oauth')

Usage

See the twitter example for a three legged authentication example.

Creating a client

Creating a client works exactly to the regular http client, it actually returns an subclassed http client.

client = oauth.createClient(443,'api.twitter.com,true)

Sending requests

Sending http requests is the only area that has a couple of differences from the built-in http module:

var headers = {
    some-header: 'some value' 
}

var body = {
    a: 'b'
}

req = client.request('POST', '/request_token', headers, body, null)
req.write(body);
req.end();

We will talk about that last parameter in a minute. With node you can stream the body and the only reason you must provide this up front is for the body to be included in the signature base string calculation, if you are sending a body of type 'application/x-www-form-urlencoded'. The body must be an object (it then gets converted into a properly encoded string). There are a set of default headers included but you can override them by simply providing your own, your headers get merged into the defaults. Be sure to include the same body as you specified in the request, this way you can still stream the body.

You can also specify your own oauth_* parameters in the query string:

req = client.request('POST', '/request_token?oauth_callback=oob', headers, body, null)

These params get split out and included in the authorization header.

Signatures

That last parameter is the only portion that takes some setup. This is the piece that calculates and signed your requests. There are two types provided: Plaintext & HMAC-SHA1 (RSA in the future maybe)

var consumer = oauth.createConsumer('key','secret');
var signer = oauth.createHMAC(consumer);
..

client.request('POST', '/request_token', headers, body, signer);

If you have an authorized or unauthorized token you can provide that to the createHMAC constructor as well. You just need to provide the type of signature you want along with the consumer and tokens, requests get automatically signed.

Consumers and Tokens

Consumers and tokens both have a utility method decode() that will take an http response and collect the form encoded responses.

var data = ''

requestToken.addListener('response', function (response) {
    response.addListener('data', function (chunk) { data+=chunk });
    response.addListener('end', onRequestTokenResponse);
});

function onRequestTokenResponse() {
    token.decode(data);
    ..
}

Tests

I am not sure the total code coverage of the tests at this point, but it is quickly getting there.Running the tests requires vows. See vows to get started.

Once installed:

vows tests/*

License

(The MIT License)

Copyright (c) 2009 Ryan Fairchild <ryan.fairchild [at] gmail [dot] com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.