Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
97c7fee
commit f506fe2
Showing
19 changed files
with
865 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,35 @@ | |||
* Fake HTTP method from OpenID server since they only support a GET. Eliminates the need to set an extra route to match the server's reply. [Josh Peek] | |||
|
|||
* OpenID 2.0 recommends that forms should use the field name "openid_identifier" rather than "openid_url" [Josh Peek] | |||
|
|||
* Return open_id_response.display_identifier to the application instead of .endpoints.claimed_id. [nbibler] | |||
|
|||
* Add Timeout protection [Rick] | |||
|
|||
* An invalid identity url passed through authenticate_with_open_id will no longer raise an InvalidOpenId exception. Instead it will return Result[:missing] to the completion block. | |||
|
|||
* Allow a return_to option to be used instead of the requested url [Josh Peek] | |||
|
|||
* Updated plugin to use Ruby OpenID 2.x.x [Josh Peek] | |||
|
|||
* Tied plugin to ruby-openid 1.1.4 gem until we can make it compatible with 2.x [DHH] | |||
|
|||
* Use URI instead of regexps to normalize the URL and gain free, better matching #8136 [dkubb] | |||
|
|||
* Allow -'s in #normalize_url [Rick] | |||
|
|||
* remove instance of mattr_accessor, it was breaking tests since they don't load ActiveSupport. Fix Timeout test [Rick] | |||
|
|||
* Throw a InvalidOpenId exception instead of just a RuntimeError when the URL can't be normalized [DHH] | |||
|
|||
* Just use the path for the return URL, so extra query parameters don't interfere [DHH] | |||
|
|||
* Added a new default database-backed store after experiencing trouble with the filestore on NFS. The file store is still available as an option [DHH] | |||
|
|||
* Added normalize_url and applied it to all operations going through the plugin [DHH] | |||
|
|||
* Removed open_id? as the idea of using the same input box for both OpenID and username has died -- use using_open_id? instead (which checks for the presence of params[:openid_url] by default) [DHH] | |||
|
|||
* Added OpenIdAuthentication::Result to make it easier to deal with default situations where you don't care to do something particular for each error state [DHH] | |||
|
|||
* Stop relying on root_url being defined, we can just grab the current url instead [DHH] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,231 @@ | |||
OpenIdAuthentication | |||
==================== | |||
|
|||
Provides a thin wrapper around the excellent ruby-openid gem from JanRan. Be sure to install that first: | |||
|
|||
gem install ruby-openid | |||
|
|||
To understand what OpenID is about and how it works, it helps to read the documentation for lib/openid/consumer.rb | |||
from that gem. | |||
|
|||
The specification used is http://openid.net/specs/openid-authentication-2_0.html. | |||
|
|||
|
|||
Prerequisites | |||
============= | |||
|
|||
OpenID authentication uses the session, so be sure that you haven't turned that off. It also relies on a number of | |||
database tables to store the authentication keys. So you'll have to run the migration to create these before you get started: | |||
|
|||
rake open_id_authentication:db:create | |||
|
|||
Or, use the included generators to install or upgrade: | |||
|
|||
./script/generate open_id_authentication_tables MigrationName | |||
./script/generate upgrade_open_id_authentication_tables MigrationName | |||
|
|||
Alternatively, you can use the file-based store, which just relies on on tmp/openids being present in RAILS_ROOT. But be aware that this store only works if you have a single application server. And it's not safe to use across NFS. It's recommended that you use the database store if at all possible. To use the file-based store, you'll also have to add this line to your config/environment.rb: | |||
|
|||
OpenIdAuthentication.store = :file | |||
|
|||
This particular plugin also relies on the fact that the authentication action allows for both POST and GET operations. | |||
If you're using RESTful authentication, you'll need to explicitly allow for this in your routes.rb. | |||
|
|||
The plugin also expects to find a root_url method that points to the home page of your site. You can accomplish this by using a root route in config/routes.rb: | |||
|
|||
map.root :controller => 'articles' | |||
|
|||
This plugin relies on Rails Edge revision 6317 or newer. | |||
|
|||
|
|||
Example | |||
======= | |||
|
|||
This example is just to meant to demonstrate how you could use OpenID authentication. You might well want to add | |||
salted hash logins instead of plain text passwords and other requirements on top of this. Treat it as a starting point, | |||
not a destination. | |||
|
|||
Note that the User model referenced in the simple example below has an 'identity_url' attribute. You will want to add the same or similar field to whatever | |||
model you are using for authentication. | |||
|
|||
Also of note is the following code block used in the example below: | |||
|
|||
authenticate_with_open_id do |result, identity_url| | |||
... | |||
end | |||
|
|||
In the above code block, 'identity_url' will need to match user.identity_url exactly. 'identity_url' will be a string in the form of 'http://example.com' - | |||
If you are storing just 'example.com' with your user, the lookup will fail. | |||
|
|||
There is a handy method in this plugin called 'normalize_url' that will help with validating OpenID URLs. | |||
|
|||
OpenIdAuthentication.normalize_url(user.identity_url) | |||
|
|||
The above will return a standardized version of the OpenID URL - the above called with 'example.com' will return 'http://example.com/' | |||
It will also raise an InvalidOpenId exception if the URL is determined to not be valid. | |||
Use the above code in your User model and validate OpenID URLs before saving them. | |||
|
|||
config/routes.rb | |||
|
|||
map.root :controller => 'articles' | |||
map.resource :session | |||
|
|||
|
|||
app/views/sessions/new.erb | |||
|
|||
<% form_tag(session_url) do %> | |||
<p> | |||
<label for="name">Username:</label> | |||
<%= text_field_tag "name" %> | |||
</p> | |||
|
|||
<p> | |||
<label for="password">Password:</label> | |||
<%= password_field_tag %> | |||
</p> | |||
|
|||
<p> | |||
...or use: | |||
</p> | |||
|
|||
<p> | |||
<label for="openid_identifier">OpenID:</label> | |||
<%= text_field_tag "openid_identifier" %> | |||
</p> | |||
|
|||
<p> | |||
<%= submit_tag 'Sign in', :disable_with => "Signing in…" %> | |||
</p> | |||
<% end %> | |||
|
|||
app/controllers/sessions_controller.rb | |||
class SessionsController < ApplicationController | |||
def create | |||
if using_open_id? | |||
open_id_authentication | |||
else | |||
password_authentication(params[:name], params[:password]) | |||
end | |||
end | |||
|
|||
|
|||
protected | |||
def password_authentication(name, password) | |||
if @current_user = @account.users.authenticate(params[:name], params[:password]) | |||
successful_login | |||
else | |||
failed_login "Sorry, that username/password doesn't work" | |||
end | |||
end | |||
|
|||
def open_id_authentication | |||
authenticate_with_open_id do |result, identity_url| | |||
if result.successful? | |||
if @current_user = @account.users.find_by_identity_url(identity_url) | |||
successful_login | |||
else | |||
failed_login "Sorry, no user by that identity URL exists (#{identity_url})" | |||
end | |||
else | |||
failed_login result.message | |||
end | |||
end | |||
end | |||
|
|||
|
|||
private | |||
def successful_login | |||
session[:user_id] = @current_user.id | |||
redirect_to(root_url) | |||
end | |||
|
|||
def failed_login(message) | |||
flash[:error] = message | |||
redirect_to(new_session_url) | |||
end | |||
end | |||
|
|||
|
|||
|
|||
If you're fine with the result messages above and don't need individual logic on a per-failure basis, | |||
you can collapse the case into a mere boolean: | |||
|
|||
def open_id_authentication | |||
authenticate_with_open_id do |result, identity_url| | |||
if result.successful? && @current_user = @account.users.find_by_identity_url(identity_url) | |||
successful_login | |||
else | |||
failed_login(result.message || "Sorry, no user by that identity URL exists (#{identity_url})") | |||
end | |||
end | |||
end | |||
|
|||
|
|||
Simple Registration OpenID Extension | |||
==================================== | |||
|
|||
Some OpenID Providers support this lightweight profile exchange protocol. See more: http://www.openidenabled.com/openid/simple-registration-extension | |||
|
|||
You can support it in your app by changing #open_id_authentication | |||
|
|||
def open_id_authentication(identity_url) | |||
# Pass optional :required and :optional keys to specify what sreg fields you want. | |||
# Be sure to yield registration, a third argument in the #authenticate_with_open_id block. | |||
authenticate_with_open_id(identity_url, | |||
:required => [ :nickname, :email ], | |||
:optional => :fullname) do |result, identity_url, registration| | |||
case result.status | |||
when :missing | |||
failed_login "Sorry, the OpenID server couldn't be found" | |||
when :invalid | |||
failed_login "Sorry, but this does not appear to be a valid OpenID" | |||
when :canceled | |||
failed_login "OpenID verification was canceled" | |||
when :failed | |||
failed_login "Sorry, the OpenID verification failed" | |||
when :successful | |||
if @current_user = @account.users.find_by_identity_url(identity_url) | |||
assign_registration_attributes!(registration) | |||
|
|||
if current_user.save | |||
successful_login | |||
else | |||
failed_login "Your OpenID profile registration failed: " + | |||
@current_user.errors.full_messages.to_sentence | |||
end | |||
else | |||
failed_login "Sorry, no user by that identity URL exists" | |||
end | |||
end | |||
end | |||
end | |||
|
|||
# registration is a hash containing the valid sreg keys given above | |||
# use this to map them to fields of your user model | |||
def assign_registration_attributes!(registration) | |||
model_to_registration_mapping.each do |model_attribute, registration_attribute| | |||
unless registration[registration_attribute].blank? | |||
@current_user.send("#{model_attribute}=", registration[registration_attribute]) | |||
end | |||
end | |||
end | |||
|
|||
def model_to_registration_mapping | |||
{ :login => 'nickname', :email => 'email', :display_name => 'fullname' } | |||
end | |||
|
|||
Attribute Exchange OpenID Extension | |||
=================================== | |||
|
|||
Some OpenID providers also support the OpenID AX (attribute exchange) protocol for exchanging identity information between endpoints. See more: http://openid.net/specs/openid-attribute-exchange-1_0.html | |||
|
|||
Accessing AX data is very similar to the Simple Registration process, described above -- just add the URI identifier for the AX field to your :optional or :required parameters. For example: | |||
|
|||
authenticate_with_open_id(identity_url, | |||
:required => [ :email, 'http://schema.openid.net/birthDate' ]) do |result, identity_url, registration| | |||
|
|||
This would provide the sreg data for :email, and the AX data for 'http://schema.openid.net/birthDate' | |||
|
|||
|
|||
|
|||
Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,22 @@ | |||
require 'rake' | |||
require 'rake/testtask' | |||
require 'rake/rdoctask' | |||
|
|||
desc 'Default: run unit tests.' | |||
task :default => :test | |||
|
|||
desc 'Test the open_id_authentication plugin.' | |||
Rake::TestTask.new(:test) do |t| | |||
t.libs << 'lib' | |||
t.pattern = 'test/**/*_test.rb' | |||
t.verbose = true | |||
end | |||
|
|||
desc 'Generate documentation for the open_id_authentication plugin.' | |||
Rake::RDocTask.new(:rdoc) do |rdoc| | |||
rdoc.rdoc_dir = 'rdoc' | |||
rdoc.title = 'OpenIdAuthentication' | |||
rdoc.options << '--line-numbers' << '--inline-source' | |||
rdoc.rdoc_files.include('README') | |||
rdoc.rdoc_files.include('lib/**/*.rb') | |||
end |
11 changes: 11 additions & 0 deletions
11
...ation/generators/open_id_authentication_tables/open_id_authentication_tables_generator.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,11 @@ | |||
class OpenIdAuthenticationTablesGenerator < Rails::Generator::NamedBase | |||
def initialize(runtime_args, runtime_options = {}) | |||
super | |||
end | |||
|
|||
def manifest | |||
record do |m| | |||
m.migration_template 'migration.rb', 'db/migrate' | |||
end | |||
end | |||
end |
20 changes: 20 additions & 0 deletions
20
...ns/open_id_authentication/generators/open_id_authentication_tables/templates/migration.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,20 @@ | |||
class <%= class_name %> < ActiveRecord::Migration | |||
def self.up | |||
create_table :open_id_authentication_associations, :force => true do |t| | |||
t.integer :issued, :lifetime | |||
t.string :handle, :assoc_type | |||
t.binary :server_url, :secret | |||
end | |||
|
|||
create_table :open_id_authentication_nonces, :force => true do |t| | |||
t.integer :timestamp, :null => false | |||
t.string :server_url, :null => true | |||
t.string :salt, :null => false | |||
end | |||
end | |||
|
|||
def self.down | |||
drop_table :open_id_authentication_associations | |||
drop_table :open_id_authentication_nonces | |||
end | |||
end |
26 changes: 26 additions & 0 deletions
26
...id_authentication/generators/upgrade_open_id_authentication_tables/templates/migration.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,26 @@ | |||
class <%= class_name %> < ActiveRecord::Migration | |||
def self.up | |||
drop_table :open_id_authentication_settings | |||
drop_table :open_id_authentication_nonces | |||
create_table :open_id_authentication_nonces, :force => true do |t| | |||
t.integer :timestamp, :null => false | |||
t.string :server_url, :null => true | |||
t.string :salt, :null => false | |||
end | |||
end | |||
|
|||
def self.down | |||
drop_table :open_id_authentication_nonces | |||
|
|||
create_table :open_id_authentication_nonces, :force => true do |t| | |||
t.integer :created | |||
t.string :nonce | |||
end | |||
|
|||
create_table :open_id_authentication_settings, :force => true do |t| | |||
t.string :setting | |||
t.binary :value | |||
end | |||
end | |||
end |
11 changes: 11 additions & 0 deletions
11
.../upgrade_open_id_authentication_tables/upgrade_open_id_authentication_tables_generator.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,11 @@ | |||
class UpgradeOpenIdAuthenticationTablesGenerator < Rails::Generator::NamedBase | |||
def initialize(runtime_args, runtime_options = {}) | |||
super | |||
end | |||
|
|||
def manifest | |||
record do |m| | |||
m.migration_template 'migration.rb', 'db/migrate' | |||
end | |||
end | |||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,18 @@ | |||
if config.respond_to?(:gems) | |||
config.gem 'ruby-openid', :lib => 'openid', :version => '>=2.0.4' | |||
else | |||
begin | |||
require 'openid' | |||
rescue LoadError | |||
begin | |||
gem 'ruby-openid', '>=2.0.4' | |||
rescue Gem::LoadError | |||
puts "Install the ruby-openid gem to enable OpenID support" | |||
end | |||
end | |||
end | |||
|
|||
config.to_prepare do | |||
OpenID::Util.logger = Rails.logger | |||
ActionController::Base.send :include, OpenIdAuthentication | |||
end |
Oops, something went wrong.