sanger-rack_authentication_sso 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2009, Wellcome Trust Sanger Institute
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of the Wellcome Trust Sanger Institute nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,13 @@
+= Sanger::Rack::Authentication::SSO
+
+This app is a piece of Rack Middleware to abstract the Single Sign-On used
+by the Sanger Institute.
+
+It may or (more likely) may not work with other SSO solutions.
+
+At this moment, see the tests for the settings that need to be passed in when
+using this middleware in a Rackup file or similar.
+
+== Copyright
+
+Copyright (c) 2009 Wellcome Trust Sanger Institute. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack_authentication_sso"
+    gem.summary = %Q{Rack middleware to abstract Sanger SSO}
+    gem.email = "paul.thornthwaite@sanger.ac.uk"
+    gem.homepage = "http://github.com/sanger/rack_authentication_sso"
+    gem.authors = ["Paul Thornthwaite"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack_authentication_sso #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/rack_authentication_sso.rb

@@ -0,0 +1,64 @@
+require "cgi"
+require "open-uri"
+require "openssl"
+require "ostruct"
+
+module Sanger
+  module Rack
+    module Authentication
+      class SSO
+      
+        def initialize(app, settings = {})
+          @config = OpenStruct.new
+          @config.magic_header_name = settings["magic_header_name"]
+          @config.cookie_name = settings["cookie_name"]
+          @config.validation_url = settings["validation_url"]
+          @config.user_agent = settings["user_agent"]
+          @config.sso_redirection_url = settings["sso_redirection_url"]
+          @config.error_text = settings["error_text"]
+          
+          @app = app
+        end
+        
+        def call(env)
+          @request = ::Rack::Request.new(env)
+          @request.env.delete(@config.magic_header_name)
+          cookie_value = @request.cookies[@config.cookie_name]
+          begin
+            user = sso_login_from_cookie(cookie_value) unless cookie_value.nil?
+            if user
+              @request.env[@config.magic_header_name] = user
+              @app.call(@request.env)
+            else
+              redirect_to_sso_server
+            end
+          rescue ::OpenURI::HTTPError
+            error_text = @config.error_text.to_s
+            [503, {"Content-Type" => "text/plain", "Content-Length" => error_text.length.to_s}, [error_text]]
+          end
+        end
+        
+        def sso_login_from_cookie(cookie_value)
+          login = nil
+          ::OpenURI.open_uri(@config.validation_url,
+            "Cookie" => "#{@config.cookie_name}=#{cookie_value}",
+            "User-Agent" => @config.user_agent) do |http|
+            login = http.read.strip
+          end
+          if login == '*'
+            return nil
+          else
+            return login
+          end
+        end
+        
+        def redirect_to_sso_server
+          @response = ::Rack::Response.new
+          destination = ::CGI::escape(@request.url)
+          @response.redirect([@config.sso_redirection_url, destination].join)
+          @response.finish
+        end
+      end
+    end
+  end
+end

data/rack_authentication_sso.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack_authentication_sso}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Thornthwaite"]
+  s.date = %q{2009-06-23}
+  s.email = %q{paul.thornthwaite@sanger.ac.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack_authentication_sso.rb",
+     "rack_authentication_sso.gemspec",
+     "test/rack_authentication_sso_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sanger/rack_authentication_sso}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Rack middleware to abstract Sanger SSO}
+  s.test_files = [
+    "test/rack_authentication_sso_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/rack_authentication_sso_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class MainTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  MAGIC_HEADER_NAME = "SEQUENCESCAPE_LOGIN"
+  COOKIE_NAME = "MyCookie"
+
+  def app
+    settings = {
+      "magic_header_name" => MAGIC_HEADER_NAME,
+      "cookie_name" => COOKIE_NAME,
+      "validation_url" => "https://sso.example.com/validation",
+      "user_agent" => "Ruby/prodsoft-code",
+      "sso_redirect_url_prefix" => "https://sso.example.com/login?destination=",
+      "error_text" => "Service unavailable"
+    }
+    Sanger::Rack::Authentication::SSO.new(lambda { |env| [200, {}, ["OK"]] }, settings)
+  end
+
+  def test_should_authenticate_if_cookie_passed_in
+    Sanger::Rack::Authentication::SSO.any_instance.\
+      expects(:sso_login_from_cookie).returns("ab3")
+    get "/", {}, {"HTTP_COOKIE" => "#{COOKIE_NAME}=12345"}
+    assert_equal 200, last_response.status
+  end
+
+  def test_should_not_authenticate_if_login_not_returned
+    Sanger::Rack::Authentication::SSO.any_instance.\
+      expects(:sso_login_from_cookie).returns("*")
+    get "/", {}, {"HTTP_COOKIE" => "#{COOKIE_NAME}=12345"}
+    assert_equal 200, last_response.status
+  end
+
+  def test_should_not_authenticate_if_network_error
+    ::OpenURI.expects(:open_uri).raises(::OpenURI::HTTPError.new("Network error", nil))
+    get "/", {}, {"HTTP_COOKIE" => "#{COOKIE_NAME}=12345"}
+    assert_equal 503, last_response.status
+  end
+
+  def test_should_redirect_if_no_headers
+    get "/", {}, {}
+    assert_equal 302, last_response.status
+    assert last_response.headers.include?("Location")
+  end
+  
+  def test_should_clear_passed_login_header
+    get "/", {}, {MAGIC_HEADER_NAME => "sneak"}
+    assert_equal 302, last_response.status
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require "rack/test"
+require "mocha"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack_authentication_sso'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: sanger-rack_authentication_sso
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Paul Thornthwaite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: paul.thornthwaite@sanger.ac.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack_authentication_sso.rb
+- rack_authentication_sso.gemspec
+- test/rack_authentication_sso_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/sanger/rack_authentication_sso
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Rack middleware to abstract Sanger SSO
+test_files: 
+- test/rack_authentication_sso_test.rb
+- test/test_helper.rb