Skip to content
hancock is an OpenID based Single Sign On provider written in Sinatra.
Pull request Compare This branch is 57 commits ahead of b:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
examples/dragon
features
lib
spec
.gitignore
AUTHORS
Gemfile
LICENSE
README.md
Rakefile
hancock.graffle

README.md

hancock

It's like your John Hancock for all of your company's apps.

A lot of this is extracted from our internal single sign on server at Engine Yard. We use a different datamapper backend but it should be a great start for most people.

Features

An OpenID based Single Sign On server that provides:

  • a single authoritative source for user authentication
  • a whitelist for consumer applications
  • integration with the big ruby frameworks via rack.
  • configurable sreg parameters to consumers

How it Works

SSO Handshake

This handshake seems kind of complex but it only happens when you need to validate a user session on the consumer.

Your Rackup File

#  thin start -p PORT -R config.ru
require 'rubygems'
require 'hancock'

DataMapper.setup(:default, "sqlite3:///#{Dir.pwd}/development.db")

class Dragon < Hancock::App
  set :views,  'views'
  set :public, 'public'
  set :environment, :production

  set :provider_name, 'Example SSO Provider'
  set :do_not_reply,  'sso@atmos.org'
  set :smtp, {
    :host   => 'smtp.example.com',
    :port   => '25',
    :user   => 'sso',
    :pass   => 'lolerskates',
    :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
    :domain => "example.com" # the HELO domain provided by the client to the server
  }

  get '/' do
    redirect '/sso/login' unless session['hancock_server_user_id']
    erb "<h2>Hello <%= session_user.name %><!-- <%= session.inspect %>"
  end
end
run Dragon

Installation

You need the rubygem bundler to function, and you MUST use the files in bin/ for generated gem executables.

% sudo gem install bundler
% gem bundle
% bin/rake 

Deployment Setup

You can deploy hancock on any rack compatible setup. You need a database that datamapper can connect to. Generate an example rackup file for yourself based on the example above.

% irb
>> require 'rubygems'
=> false
>> require 'hancock'
=> true
>> DataMapper.setup(:default, "sqlite3:///#{Dir.pwd}/development.db")
=> #<DataMapper::Adapters::Sqlite3Adapter:0x1ae639c ...>
>> DataMapper.auto_migrate!
=> [Hancock::User, Hancock::Consumer]

Consult the datamapper documentation if you need to connect to something other than sqlite. This runs the initial user migration to bootstrap your db.

>> Hancock::Consumer.create(:url => 'http://hr.example.com/sso/login', :label => 'Human Resources', :internal => true)
=> ...
>> Hancock::Consumer.create(:url => 'http://localhost:3000/sso/login', :label => 'Local Rails Dev', :internal => false)
=> ...
>> Hancock::Consumer.create(:url => 'http://localhost:4000/sso/login', :label => 'Local Merb Dev', :internal => false)
=> ...
>> Hancock::Consumer.create(:url => 'http://localhost:4567/sso/login', :label => 'Local Sinatra Dev', :internal => false)

Here's how you setup most frameworks as consumers. In a production environment you'd lock this down

Feedback

Sponsored By

Something went wrong with that request. Please try again.