Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Easy and simple oauth for your Express (node.js) website
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
static
views
.gitignore
README.md
example.js
example_keys_file.js
package.json

README.md

EasyOAuth

EasyOAuth is a simple module that is intended to make it very easy to add OAuth to your node.js website.

Installation

npm install easy-oauth

This will automatically install the dependencies (connect, oauth, connect-auth, express)

Usage

(1) Setup your OAuth Keys

(2) Usage on the Server Side (NOTE: This example assumes you are using express 2.0 however, the module will work with earlier versions of express)

    var connect = require('connect');
    var express = require('express');
    var easyoauth = require('easy-oauth');
    var server = express.createServer();
    server.configure(function(){
        server.set('views', __dirname + '/views');
        server.use(connect.bodyParser());
        server.use(express.cookieParser());
        server.use(express.session({secret : "shhhhhhhhhhhhhh!"}));
        server.use(connect.static(__dirname + '/static'));
        server.use(easyoauth(require('./keys_file')));
        server.use(server.router);
    });

Easily check on any route if a user has been authenticated

    server.get('/my-account', function(req,res){
      req.authenticate(['oauth'], function(error, authenticated) { 
        if( authenticated ){
          //This user is logged in
          //render out a page for the logged in user
        }
        else{
          //This user is not logged in
          //render out a login page
        }
      });
    });

(3) Usage on the Client Side

Include JQuery and the EasyOAuth Client Lib

    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
    <script>!window.jQuery && document.write('<script src="js/jquery-1.4.2.min.js"><\/script>')</script>
    <script src="/auth/client"></script>

Then use it in your client side javascript:

    var authcallback = function(data){
      $('.details').html('<p>You are all signed in as <strong>'
            +data.user.username+
            '</strong><br>...and here are some details:'
            +JSON.stringify(data.user)+
            '</p><a href="/logout">logout</a>').fadeIn('slow');
    }

    $('#twitbutt').click(function(){
      openEasyOAuthBox('twitter',authcallback);
    });

    $('#facebutt').click(function(){
       openEasyOAuthBox('facebook',authcallback);
    });

(4) Access Protected Resources

Once a user has OAuth'd in, you will have access to the access keys via the expressjs request object using req.getAuthDetails(). For more information about how to use req.getAuthDetails() to access protected resources, checkout @ciaran_j's https://github.com/ciaranj/connect-auth

Something went wrong with that request. Please try again.