rack-pubcookie 0.0.2 → 0.0.3

data/README.md

@@ -30,8 +30,9 @@ Once these six pieces have been obtained, you can then use it like this:
 # This is located in config.ru
 require 'rack/pubcookie'
 
-use Rack::Pubcookie::Auth, @login_server, @hostname, @appid, @keyfile_path,
-  @granting_certificate_path
+use Rack::Pubcookie, :login_server => @login_server, :host_name => @hostname,
+  :appid => @appid, :keyfile_path => @keyfile_path,
+  :granting_cert => @granting_certificate_path
 
 # @login_server => 'login.example.com[:port]' (port optional)
 # @hostname     => 'myapp.example.com[:port]' (port optional)

data/lib/rack/pubcookie.rb

@@ -1,11 +1,33 @@
 require 'rack'
 
+require 'rack/pubcookie/version'
+require 'rack/pubcookie/auth'
+
 module Rack
-  module Pubcookie
-    autoload :VERSION, 'rack/pubcookie/version'
+  class Pubcookie
+
+    include Auth
+
+    def initialize app, options
+      @app = app
+      self.pubcookie_options = options
+    end
+
+    def call env
+      request = Rack::Request.new env
+
+      if request.path == '/auth/pubcookie'
+        response = Rack::Response.new login_page_html
+      else
+        request.env['REMOTE_USER'] = extract_username request
+        status, headers, body = @app.call(request.env)
+        response = Rack::Response.new body, status, headers
+
+        set_pubcookie! request, response
+      end
+
+      response.finish
+    end
 
-    autoload :Auth, 'rack/pubcookie/auth'
-    autoload :AES, 'rack/pubcookie/aes'
-    autoload :DES, 'rack/pubcookie/des'
   end
 end

data/lib/rack/pubcookie/aes.rb

@@ -1,5 +1,5 @@
 module Rack
-  module Pubcookie
+  class Pubcookie
     module AES
 
       def aes_decrypt bytes, index1, index2

data/lib/rack/pubcookie/auth.rb

@@ -2,49 +2,42 @@ require 'rack/utils'
 require 'openssl'
 require 'base64'
 
+require 'rack/pubcookie/aes'
+require 'rack/pubcookie/des'
+
 module Rack
-  module Pubcookie
-    class Auth
+  class Pubcookie
+    module Auth
 
       include AES
       include DES
 
-      def initialize app, login_server, host, appid, keyfile, granting_cert,
-          opts = {}
-        @app          = app
-        @login_server = login_server
-        @host         = host
-        @appid        = appid
-        @keyfile      = keyfile
-        @granting = OpenSSL::X509::Certificate.new(::File.read(granting_cert))
+      def pubcookie_options= options
+        @login_server  = options[:login_server]
+        @host          = options[:host]
+        @appid         = options[:appid]
+        @keyfile       = options[:keyfile]
+        @granting_cert = options[:granting_cert]
+
+        if @login_server.nil? || @host.nil? || @appid.nil? || @keyfile.nil? ||
+            @granting_cert.nil?
+          raise 'Need all of :login_server, :host, :appid, :keyfile, and :granting_cert specified to use pubcookie!'
+        end
+
+        @granting = OpenSSL::X509::Certificate.new(::File.read(@granting_cert))
         ::File.open(@keyfile, 'rb'){ |f| @key = f.read.bytes.to_a }
 
-        @options = opts
-        @options[:expires_after] = 24 * 3600 # 24 hrs
+        @expires_after ||= options[:expires_after] || 24 * 3600 # 24 hrs
       end
 
-      def call env
-        request = Rack::Request.new env
-
-        if request.path == '/auth/pubcookie'
-          response = Rack::Response.new login_page_html
-        else
-          request.env['REMOTE_USER'] = extract_username request
-          status, headers, body = @app.call(request.env)
-          response = Rack::Response.new body, status, headers
-
-          if !request.params['pubcookie_g'].nil? &&
-              request.params['pubcookie_g'] != request.cookies['pubcookie_g']
-            response.set_cookie 'pubcookie_g', :path => '/', :secure => true,
-              :value => request.params['pubcookie_g']
-          end
+      def set_pubcookie! request, response
+        if !request.params['pubcookie_g'].nil? &&
+            request.params['pubcookie_g'] != request.cookies['pubcookie_g']
+          response.set_cookie 'pubcookie_g', :path => '/', :secure => true,
+            :value => request.params['pubcookie_g']
         end
-
-        response.finish
       end
 
-      protected
-
       def extract_username request
         # If coments below refer to a URL, they mean this one:
         # http://svn.cac.washington.edu/viewvc/pubcookie/trunk/src/pubcookie.h?view=markup
@@ -73,38 +66,13 @@ module Rack
         create_ts = Time.at create_ts
         last_ts   = Time.at last_ts
 
-        if Time.now < create_ts + @options[:expires_after] && appid == @appid
+        if Time.now < create_ts + @expires_after && appid == @appid
           user
         else
           nil
         end
       end
 
-      # For a better description on what each of these values are, go to
-      # https://wiki.doit.wisc.edu/confluence/display/WEBISO/Pubcookie+Granting+Request+Interface
-      def request_login_arguments
-        args = {
-          :one          => @host,     # FQDN of our host
-          :two          => @appid,    # Our AppID for pubcookie
-          :three        => 1,         # ?
-          :four         => 'a5',      # Version/encryption?
-          :five         => 'GET',     # method, even though we lie?
-          :six          => @host,     # our host domain name
-          :seven        => '/auth/pubcookie/callback', # Where to return
-          :eight        => '',        # ?
-          :nine         => 1,         # Probably should be different...
-          :hostname     => @host,     # Pubcookie needs it 3 times...
-          :referer      => '(null)',  # Just don't bother
-          :sess_re      => 0,         # Don't force re-authentication
-          :pre_sess_tok => Kernel.rand(2000000), # Just a random 32bit number
-          :flag         => 0,         # ?
-          :file         => ''         # ?
-        }
-
-        args[:seven] = Base64.encode64(args[:seven]).chomp
-        args
-      end
-
       def login_page_html
         query = request_login_arguments.to_a.map{ |k, v|
           "#{k}=#{Rack::Utils.escape v}"
@@ -133,6 +101,37 @@ module Rack
 HTML
       end
 
+      def callback_path
+        '/auth/pubcookie/callback'
+      end
+
+      protected
+
+      # For a better description on what each of these values are, go to
+      # https://wiki.doit.wisc.edu/confluence/display/WEBISO/Pubcookie+Granting+Request+Interface
+      def request_login_arguments
+        args = {
+          :one          => @host,     # FQDN of our host
+          :two          => @appid,    # Our AppID for pubcookie
+          :three        => 1,         # ?
+          :four         => 'a5',      # Version/encryption, yet ignored...
+          :five         => 'GET',     # method, even though we lie...
+          :six          => @host,     # our host domain name
+          :seven        => callback_path, # Where to return
+          :eight        => '',        # ?
+          :nine         => 1,         # Probably should be different...
+          :hostname     => @host,     # Again, our FQDN
+          :referer      => '(null)',  # Doesn't matter if no referer
+          :sess_re      => 0,         # Don't force re-authentication
+          :pre_sess_tok => Kernel.rand(2000000), # Just a random 32bit number
+          :flag         => 0,         # ?
+          :file         => ''         # ?
+        }
+
+        args[:seven] = Base64.encode64(args[:seven]).chomp
+        args
+      end
+
     end
   end
 end

data/lib/rack/pubcookie/des.rb

@@ -1,5 +1,5 @@
 module Rack
-  module Pubcookie
+  class Pubcookie
     module DES
 
       def des_decrypt bytes, index1, index2

data/lib/rack/pubcookie/version.rb

@@ -1,5 +1,5 @@
 module Rack
-  module Pubcookie
-    VERSION = '0.0.2'
+  class Pubcookie
+    VERSION = '0.0.3'
   end
 end

data/spec/rack/{pubcookie/auth_spec.rb → pubcookie_spec.rb}

@@ -1,14 +1,15 @@
 require 'spec_helper'
 
-describe Rack::Pubcookie::Auth do
+describe Rack::Pubcookie do
 
   include Rack::Test::Methods
 
   def app
     Rack::Builder.new {
-      use Rack::Pubcookie::Auth, 'example.com', 'myhost.com', 'testappid',
-        Rack::Test.fixture_path + '/test.com',
-        Rack::Test.fixture_path + '/granting.crt'
+      use Rack::Pubcookie, :login_server => 'example.com',
+        :host => 'myhost.com', :appid => 'testappid',
+        :keyfile => Rack::Test.fixture_path + '/test.com',
+        :granting_cert => Rack::Test.fixture_path + '/granting.crt'
       run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['llama']] }
     }.to_app
   end
@@ -113,9 +114,10 @@ describe Rack::Pubcookie::Auth do
   describe "an invalid signature" do
     def app
       Rack::Builder.new {
-        use Rack::Pubcookie::Auth, 'example.com', 'myhost.com', 'testappid',
-          Rack::Test.fixture_path + '/test.com',
-          Rack::Test.fixture_path + '/invalid.crt'
+        use Rack::Pubcookie, :login_server => 'example.com',
+          :host => 'myhost.com', :appid => 'testappid',
+          :keyfile => Rack::Test.fixture_path + '/test.com',
+          :granting_cert => Rack::Test.fixture_path + '/invalid.crt'
         run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['llama']] }
       }.to_app
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alex Crichton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-18 00:00:00 -06:00
+date: 2011-01-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,13 +84,12 @@ files:
 - lib/rack/pubcookie/aes.rb
 - lib/rack/pubcookie/auth.rb
 - lib/rack/pubcookie/des.rb
-- lib/rack/pubcookie/fake.rb
 - lib/rack/pubcookie/version.rb
 - README.md
 - spec/fixtures/granting.crt
 - spec/fixtures/invalid.crt
 - spec/fixtures/test.com
-- spec/rack/pubcookie/auth_spec.rb
+- spec/rack/pubcookie_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/alexcrichton/rack-pubcookie
@@ -128,5 +127,5 @@ test_files:
 - spec/fixtures/granting.crt
 - spec/fixtures/invalid.crt
 - spec/fixtures/test.com
-- spec/rack/pubcookie/auth_spec.rb
+- spec/rack/pubcookie_spec.rb
 - spec/spec_helper.rb

data/lib/rack/pubcookie/fake.rb

@@ -1,22 +0,0 @@
-module Rack
-  module Pubcookie
-
-    # This Rack interface is meant to be used in development. It mocks out
-    # pubcookie authentication by always setting the REMOTE_USER variable to
-    # a specific username given to the constructor.
-    #
-    # This is not meant to be used in production obviously...
-    class Fake
-
-      def initialize app, username
-        @app, @username = app, username
-      end
-
-      def call env
-        env['REMOTE_USER'] = @username
-        @app.call env
-      end
-
-    end
-  end
-end