rack-federated-auth 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,15 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ gem "omniauth"
7
+
8
+ # Add dependencies to develop your gem here.
9
+ # Include everything needed to run rake, tests, features, etc.
10
+ group :development do
11
+ gem "shoulda", ">= 0"
12
+ gem "rdoc", "~> 3.12"
13
+ gem "bundler", "~> 1.0.0"
14
+ gem "jeweler", "~> 1.8.3"
15
+ end
@@ -0,0 +1,33 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ hashie (1.2.0)
6
+ jeweler (1.8.3)
7
+ bundler (~> 1.0)
8
+ git (>= 1.2.5)
9
+ rake
10
+ rdoc
11
+ json (1.6.5)
12
+ omniauth (1.0.3)
13
+ hashie (~> 1.2)
14
+ rack
15
+ rack (1.4.1)
16
+ rake (0.9.2.2)
17
+ rdoc (3.12)
18
+ json (~> 1.4)
19
+ shoulda (3.0.1)
20
+ shoulda-context (~> 1.0.0)
21
+ shoulda-matchers (~> 1.0.0)
22
+ shoulda-context (1.0.0)
23
+ shoulda-matchers (1.0.0)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ bundler (~> 1.0.0)
30
+ jeweler (~> 1.8.3)
31
+ omniauth
32
+ rdoc (~> 3.12)
33
+ shoulda
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2012 Ryan Michael
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,56 @@
1
+ Rack Federated Authentication
2
+ =======
3
+
4
+ This gem is intended to provide a quick way to authenticate a Rack-based application using one of OmniAuth's
5
+ federated authentication strategies. The idea is to be able to quickly restrict access to a Rack app based on
6
+ and existing authentication system such as Google Apps.
7
+
8
+ Install
9
+ ------
10
+
11
+ Add it to your gemfile
12
+
13
+ gem "rack_federated_auth"
14
+
15
+ Use it in your Rack application
16
+
17
+ ``` ruby
18
+ class MyApp < Sinatra::Base
19
+
20
+ use Rack::Session::Cookie, :secret => ENV['SESSION_SECRET']
21
+
22
+ use OmniAuth::Builder do
23
+ provider :google_oauth2, ENV['OAUTH_CLIENT_ID'], ENV['OAUTH_CLIENT_SECRET'], {:access_type => 'online', :approval_prompt => ''}
24
+ end
25
+
26
+ use RackFederatedAuth::Authentication do |config|
27
+ config.email_filter = /yourdomain\.com$/
28
+ end
29
+ end
30
+ ```
31
+
32
+ The gem handles forwarding users to the authentication URL if they haven't authenticated,
33
+ recieving the authentication callback, and setting the user's session so authentication isn't
34
+ required before each page request.
35
+
36
+ Most federated login stragegies for OmniAuth should work - if you want to use something other than google-oauth2,
37
+ you can set the auth url accordingly:
38
+
39
+ ```ruby
40
+ use RackFederatedAuth::Authentication do |config|
41
+ config.auth_url = '/auth/yahoo?openid_url=https://me.yahoo.com'
42
+ end
43
+ ```
44
+
45
+ You can restrict who can access the site based on email by setting `email_filter` to a regex which
46
+ will only match on users you'd like to allow to authenticate. You can also specify a custom `failure_message`
47
+ to display on authentication failure (this can be useful if users need to auth with a specific email)
48
+
49
+
50
+
51
+ Copyright
52
+ ---------
53
+
54
+ Copyright (c) 2012 Ryan Michael. See LICENSE.txt for
55
+ further details.
56
+
@@ -0,0 +1,45 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "rack-federated-auth"
18
+ gem.homepage = "http://github.com/kerinin/rack-federated-auth"
19
+ gem.license = "MIT"
20
+ gem.summary = %Q{Rack middleware using for federated authentication}
21
+ gem.description = %Q{Provides a simple authentication middleware to lock down Rack-based apps}
22
+ gem.email = "kerinin@gmail.com"
23
+ gem.authors = ["Ryan Michael"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ task :default => :test
36
+
37
+ require 'rdoc/task'
38
+ Rake::RDocTask.new do |rdoc|
39
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
40
+
41
+ rdoc.rdoc_dir = 'rdoc'
42
+ rdoc.title = "rack-federated-auth #{version}"
43
+ rdoc.rdoc_files.include('README*')
44
+ rdoc.rdoc_files.include('lib/**/*.rb')
45
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,49 @@
1
+ require 'sinatra'
2
+
3
+ module RackFederatedAuth
4
+ class Authentication < Sinatra::Base
5
+ attr_accessor :auth_url
6
+ attr_accessor :email_filter
7
+ attr_accessor :failure_message
8
+
9
+ def initialize(app)
10
+ @auth_url = "/auth/google_oauth2"
11
+ @email_filter = /.*/
12
+ @failure_message = "Authentication failed. Click <a href='#{@auth_url}'>here</a> to try again"
13
+
14
+ yield self if block_given?
15
+
16
+ super(app)
17
+ end
18
+
19
+ def authenticated?
20
+ !session['authorized'].nil? and session['authorized']
21
+ end
22
+
23
+ before /^(?!\/(auth))/ do
24
+ redirect @auth_url unless authenticated?
25
+ end
26
+
27
+ get "/auth/:service/callback" do
28
+ puts "New #{params[:service]} auth: #{request.env['omniauth.auth']}"
29
+ begin
30
+ if request.env['omniauth.auth']['info']['email'].match(@email_filter)
31
+ puts "email matches filter"
32
+ session['authorized'] = true
33
+ redirect '/'
34
+ else
35
+ puts "email doesn't match filter"
36
+ redirect '/auth/failure'
37
+ end
38
+ rescue
39
+ puts "Auth failure :("
40
+ session['authorized'] = false
41
+ redirect '/auth/failure'
42
+ end
43
+ end
44
+
45
+ get '/auth/failure' do
46
+ "<html><body>#{@failure_message}</body></html>"
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,62 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = "rack-federated-auth"
8
+ s.version = "0.1.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Ryan Michael"]
12
+ s.date = "2012-03-20"
13
+ s.description = "Provides a simple authentication middleware to lock down Rack-based apps"
14
+ s.email = "kerinin@gmail.com"
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.md"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ "Gemfile",
22
+ "Gemfile.lock",
23
+ "LICENSE.txt",
24
+ "README.md",
25
+ "Rakefile",
26
+ "VERSION",
27
+ "lib/rack-federated-auth.rb",
28
+ "rack-federated-auth.gemspec",
29
+ "test/helper.rb",
30
+ "test/test_rack-federated-auth.rb"
31
+ ]
32
+ s.homepage = "http://github.com/kerinin/rack-federated-auth"
33
+ s.licenses = ["MIT"]
34
+ s.require_paths = ["lib"]
35
+ s.rubygems_version = "1.8.10"
36
+ s.summary = "Rack middleware using for federated authentication"
37
+
38
+ if s.respond_to? :specification_version then
39
+ s.specification_version = 3
40
+
41
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
42
+ s.add_runtime_dependency(%q<omniauth>, [">= 0"])
43
+ s.add_development_dependency(%q<shoulda>, [">= 0"])
44
+ s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
45
+ s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
46
+ s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
47
+ else
48
+ s.add_dependency(%q<omniauth>, [">= 0"])
49
+ s.add_dependency(%q<shoulda>, [">= 0"])
50
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
51
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
52
+ s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
53
+ end
54
+ else
55
+ s.add_dependency(%q<omniauth>, [">= 0"])
56
+ s.add_dependency(%q<shoulda>, [">= 0"])
57
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
58
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
59
+ s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
60
+ end
61
+ end
62
+
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'rack-federated-auth'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestRackFederatedAuth < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rack-federated-auth
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Ryan Michael
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-03-20 00:00:00.000000000Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: omniauth
16
+ requirement: &2169195240 !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: *2169195240
25
+ - !ruby/object:Gem::Dependency
26
+ name: shoulda
27
+ requirement: &2169194700 !ruby/object:Gem::Requirement
28
+ none: false
29
+ requirements:
30
+ - - ! '>='
31
+ - !ruby/object:Gem::Version
32
+ version: '0'
33
+ type: :development
34
+ prerelease: false
35
+ version_requirements: *2169194700
36
+ - !ruby/object:Gem::Dependency
37
+ name: rdoc
38
+ requirement: &2169194200 !ruby/object:Gem::Requirement
39
+ none: false
40
+ requirements:
41
+ - - ~>
42
+ - !ruby/object:Gem::Version
43
+ version: '3.12'
44
+ type: :development
45
+ prerelease: false
46
+ version_requirements: *2169194200
47
+ - !ruby/object:Gem::Dependency
48
+ name: bundler
49
+ requirement: &2169193720 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ~>
53
+ - !ruby/object:Gem::Version
54
+ version: 1.0.0
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: *2169193720
58
+ - !ruby/object:Gem::Dependency
59
+ name: jeweler
60
+ requirement: &2169193240 !ruby/object:Gem::Requirement
61
+ none: false
62
+ requirements:
63
+ - - ~>
64
+ - !ruby/object:Gem::Version
65
+ version: 1.8.3
66
+ type: :development
67
+ prerelease: false
68
+ version_requirements: *2169193240
69
+ description: Provides a simple authentication middleware to lock down Rack-based apps
70
+ email: kerinin@gmail.com
71
+ executables: []
72
+ extensions: []
73
+ extra_rdoc_files:
74
+ - LICENSE.txt
75
+ - README.md
76
+ files:
77
+ - .document
78
+ - Gemfile
79
+ - Gemfile.lock
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - VERSION
84
+ - lib/rack-federated-auth.rb
85
+ - rack-federated-auth.gemspec
86
+ - test/helper.rb
87
+ - test/test_rack-federated-auth.rb
88
+ homepage: http://github.com/kerinin/rack-federated-auth
89
+ licenses:
90
+ - MIT
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ none: false
97
+ requirements:
98
+ - - ! '>='
99
+ - !ruby/object:Gem::Version
100
+ version: '0'
101
+ segments:
102
+ - 0
103
+ hash: -323311014631924913
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 1.8.10
113
+ signing_key:
114
+ specification_version: 3
115
+ summary: Rack middleware using for federated authentication
116
+ test_files: []