rack-webauth 0.1.1 → 0.1.2

data/examples/test/config.ru

@@ -0,0 +1,18 @@
+# -*- mode:ruby -*-
+
+$: << '../../lib/'
+require 'rack-webauth/test'
+
+use Rack::Webauth::Test, :user => "nilclass", :mail => "niklas@brueckenschlaeger.de"
+
+use Rack::Webauth
+
+run lambda { |env|
+  user = Rack::Webauth::User.new(env[Rack::Webauth::NS])
+
+  $stderr.puts "LOGIN: #{user.login}"
+  $stderr.puts "MAIL: #{user[:mail]}"
+  [200, { "Content-Type" => "text/html" },
+   ['<h1>', "All fine. Check logs.", '</h1>',
+    '<pre>', env.inspect,'</pre>']]
+}

data/lib/rack-webauth.rb

@@ -71,14 +71,37 @@ class Rack::Webauth
        (respond_to?(:request) &&
         request.respond_to?(:env) ?
         request.env[NS] :
-        (raise "Neither 'env' nor 'request.env' available. Can't access webauth-info")))
+        (raise Rack::Webauth::Info::NotAvailable.new("Neither 'env' nor 'request.env' available. Can't access webauth-info"))))
+    end
+  end
+
+  # A default User object, to easily access attributes.
+  # Used by WardenStrategy.
+  class User
+    attr :login
+
+    def initialize(webauth_info)
+      @webauth_info = webauth_info
+      @login = @webauth_info.login
+    end
+
+    def [](attribute)
+      @webauth_info.attributes[attribute.to_s.upcase]
     end
   end
 
   # Detects & provides webauth related information conveniently from
   # the rack environment.
+  #
+  # See README and Rack::Webauth::Helpers for usage information & examples.
+  #
   class Info
+    # Exception raised by Rack::Webauth::Helpers if webauth
+    # cannot be accessed / is not available.
+    class NotAvailable < Exception ; end
+
     attr :login
+    attr :env
     # explains itself.
     def logged_in? ; @logged_in ; end
 
@@ -184,6 +207,7 @@ class Rack::Webauth
         else
           # key isn't webauthldap related
         end
+        next(attrs)
       end
     end
   end

data/lib/rack-webauth/test.rb

@@ -0,0 +1,56 @@
+require 'rack-webauth'
+
+# Middleware to use for testing in situations where WebAuth is not
+# available, such as development environments.
+#
+# Example:
+#   use(Rack::Webauth::Test,
+#       :user => "test-user",
+#       :mail => "someone@example.com")
+#
+#   use(Rack::Webauth)
+#
+#   run lambda {|env|
+#     env["WEBAUTH_USER"] #=> "test-user"
+#     env["WEBAUTH_LDAP_MAIL"] #=> "someone@example.com"
+#     env[Rack::Webauth::NS].login #=> "test-user"
+#     env[Rack::Webauth::NS].attributes['mail'] #=> "someone@example.com"
+#   }
+#
+#
+# In order to work correctly, Rack::Webauth::Test must come before
+# Rack::Webauth in the middleware stack.
+#
+class Rack::Webauth::Test
+  attr_reader :app, :env_vars
+
+  def initialize(app, env_vars)
+    @app, @env_vars = app, env_vars
+  end
+
+  def call(env)
+    env_vars.each_pair do |key, value|
+      add_to_env(env, key, value)
+    end
+    app.call(env)
+  end
+
+  private
+
+  def add_to_env(env, key, value)
+    normalized_key = key.to_s.upcase
+    if %w(USER TOKEN_LASTUSED TOKEN_EXPIRATION
+          LDAPAUTHRULE LDAPPRIVGROUP).include?(normalized_key)
+      # regular setting
+      env["WEBAUTH_#{normalized_key}"] = value
+    elsif value.kind_of?(Array)
+      # multi-valued LDAP attribute
+      value.each_with_index do |val, index|
+        env["WEBAUTH_LDAP_#{normalized_key}#{index + 1}"] = val
+      end
+    else
+      # signle-valued LDAP attribute
+      env["WEBAUTH_LDAP_#{normalized_key}"] = value
+    end
+  end
+end

data/lib/rack-webauth/warden_strategy.rb

@@ -0,0 +1,92 @@
+require 'rack-webauth'
+
+unless defined?(Warden)
+  raise "Can't define warden strategy, as Warden isn't available. Get it from https://github.com/hassox/warden/"
+end
+
+# Basic strategy for Warden, a authentication framework for Rack.
+#
+# For more information about warden, see https://github.com/hassox/warden/
+#
+# You can either use this "as is", which will give you a
+# Rack::Webauth::User object to work with, or tie it to
+# your own User objects, by setting the finder.
+#
+# See Rack::Webauth::WardenStrategy.finder for more information.
+#
+# For information on how to use this in Devise, see documentation
+# of Rack::Webauth::WardenStrategy::InstanceMethods
+#
+class Rack::Webauth::WardenStrategy < Warden::Strategies::Base
+  #
+  # Actual functionality of WardenStrategy, so it can be used
+  # within other classes as well, without the need to inherit
+  # from Warden::Strategies::Base.
+  #
+  # Especially useful when using devise:
+  #
+  #   class MyWebauthStrategy < Devise::Strategies::Authenticatable
+  #     include Rack::Webauth::WardenStrategy::InstanceMethods
+  #
+  #     self.finder = lambda {
+  #       mapping.to.find_by_email(webauth.attributes['mail'])
+  #     }
+  #   end
+  #
+  # For more information about Devise see https://github.com/plataformatec/devise
+  #
+  module InstanceMethods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    include Rack::Webauth::Helpers
+
+    def valid?
+      webauth
+      true
+    rescue Rack::Webauth::Info::NotAvailable
+      false
+    end
+
+    def authenticate!
+      if webauth.logged_in?
+        if user = instance_eval(&self.class.finder)
+          success!(user)
+        else
+          fail!(:invalid)
+        end
+      else
+        fail!
+      end
+    end
+  end
+
+  module ClassMethods
+    def self.extended(base)
+      class << base
+        attr_writer :finder
+      end
+    end
+
+    # Default user finder. By default initializes a
+    # Rack::Webauth::User. You can set it to something
+    # else:
+    #
+    #   Rack::Webauth::WardenStrategy.finder = lambda {
+    #     MyUserModel.find_by_email_address(webauth.attributes['mail'])
+    #   }
+    #
+    # The finder will be evaluated inside the strategy instance,
+    # so you have access to "webauth", "env", ...
+    def finder
+      @finder ||= lambda {
+        Rack::Webauth::User.new(webauth)
+      }
+    end
+  end
+
+  include(InstanceMethods)
+end
+
+Warden::Strategies.add(:webauth, Rack::Webauth::WardenStrategy)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-webauth
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Niklas E. Cathor
@@ -46,6 +46,9 @@ files:
 - README.textile
 - COPYING
 - COPYING.LESSER
+- lib/rack-webauth/test.rb
+- lib/rack-webauth/warden_strategy.rb
+- examples/test/config.ru
 has_rdoc: true
 homepage: 
 licenses: []