omniauth--omniauth/README.markdown

OmniAuth: Standardized Multi-Provider Authentication

OmniAuth is a new Rack-based authentication system for multi-provider external authentcation. OmniAuth is built from the ground up on the philosophy that authentication is not the same as identity, and is based on two observations:

1. The traditional 'sign up using a login and password' model is becoming the exception, not the rule. Modern web applications offer external authentication via OpenID, Facebook, and/or OAuth.
2. The interconnectable web is no longer a dream, it is a necessity. It is not unreasonable to expect that one application may need to be able to connect to one, three, or twelve other services. Modern authentication systems should allow a user's identity to be associated with many authentications.

Installation

To install OmniAuth, simply install the gem:

gem install omniauth

Providers

OmniAuth currently supports the following external providers:

• via OAuth (OAuth 1.0, OAuth 2, and xAuth)
  • 37signals ID (credit: mbleigh)
  • Bit.ly (credit: philnash)
  • DailyMile (credit: cdmwebs)
  • Doit.im (credit: chouti)
  • Dopplr (credit: flextrip)
  • Douban (credit: quake)
  • Evernote (credit: szimek)
  • Facebook (credit: mbleigh)
  • Foursquare (credit: mbleigh)
  • GitHub (credit: mbleigh)
  • GoodReads (credit: cristoffer)
  • Gowalla (credit: kvnsmth)
  • Hyves (credit: mrdg)
  • Identi.ca (credit: dcu)
  • Instagram (credit: kiyoshi)
  • Instapaper (credit: micpringle)
  • LinkedIn (credit: mbleigh)
  • Meetup (credit coderoshi)
  • Miso (credit: rickenharp)
  • Mixi (credit: kiyoshi)
  • Netflix (credit: caged)
  • Qzone (credit: quake)
  • Rdio (via brandonweiss)
  • Renren (credit: quake)
  • Salesforce (via CloudSpokes)
  • SmugMug (credit: pchilton)
  • SoundCloud (credit: leemartin)
  • T163 (credit: quake)
  • TeamBox (credit jrom)
  • Tqq (credit: quake)
  • TradeMe (credit: pchilton)
  • TripIt (credit: flextrip)
  • Tsina (credit: quake)
  • Tsohu (credit: quake)
  • Tumblr (credit: jamiew)
  • Twitter (credit: mbleigh)
  • Vimeo (credit: jamiew)
  • Vkontakte (credit: german)
  • Yammer (credit: kltcalamay)
  • YouTube (credit: jamiew)
• CAS (Central Authentication Service) (credit: jamesarosen)
• Flickr (credit: pchilton)
• Google Apps (via OpenID) (credit: mbleigh)
• LDAP (credit: pyu10055)
• OpenID (credit: mbleigh)
• Yupoo (credit: chouti)

Compatibility

OmniAuth is tested against the following Ruby versions:

• 1.8.7
• 1.9.1
• 1.9.2
• jRuby (note, the Evernote strategy is not available for jRuby)
• Rubinius
• REE

Usage

OmniAuth is a collection of Rack middleware. To use a single strategy, you simply need to add the middleware:

require 'oa-oauth'
use OmniAuth::Strategies::Twitter, 'CONSUMER_KEY', 'CONSUMER_SECRET'

Now to initiate authentication you merely need to redirect the user to /auth/twitter via a link or other means. Once the user has authenticated to Twitter, they will be redirected to /auth/twitter/callback. You should build an endpoint that handles this URL, at which point you will will have access to the authentication information through the omniauth.auth parameter of the Rack environment. For example, in Sinatra you would do something like this:

get '/auth/twitter/callback' do
  auth_hash = request.env['omniauth.auth']
end

The hash in question will look something like this:

{
  'uid' => '12356',
  'provider' => 'twitter',
  'user_info' => {
    'name' => 'User Name',
    'nickname' => 'username',
    # ...
  }
}

The user_info hash will automatically be populated with as much information about the user as OmniAuth was able to pull from the given API or authentication provider.

Resources

The best place to find more information is the OmniAuth Wiki. Some specific information you might be interested in:

• CI Build Status
• Roadmap
• Changelog
• Report Issues
• Mailing List

OmniAuth Core

• Michael Bleigh (mbleigh)
• Erik Michaels-Ober (sferik)

License

OmniAuth is licensed under the MIT License.