wmernagh-rubycas-server 0.6.99.336

data/lib/casserver/authenticators/ldap.rb

@@ -0,0 +1,138 @@
+require 'casserver/authenticators/base'
+
+begin
+  require 'net/ldap'
+rescue LoadError
+  require 'rubygems'
+  begin
+    gem 'ruby-net-ldap', '~> 0.0.4'
+  rescue Gem::LoadError
+    $stderr.puts
+    $stderr.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+    $stderr.puts
+    $stderr.puts "To use the LDAP/AD authenticator, you must first install the 'ruby-net-ldap' gem."
+    $stderr.puts
+    $stderr.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+    exit 1
+  end
+  require 'net/ldap'
+end
+
+# Basic LDAP authenticator. Should be compatible with OpenLDAP and other similar LDAP servers,
+# although it hasn't been officially tested. See example config file for details on how
+# to configure it.
+class CASServer::Authenticators::LDAP < CASServer::Authenticators::Base
+  def validate(credentials)
+    read_standard_credentials(credentials)
+
+    return false if @password.blank?
+   
+    raise CASServer::AuthenticatorError, "Cannot validate credentials because the authenticator hasn't yet been configured" unless @options
+    raise CASServer::AuthenticatorError, "Invalid LDAP authenticator configuration!" unless @options[:ldap]
+    raise CASServer::AuthenticatorError, "You must specify a server host in the LDAP configuration!" unless @options[:ldap][:host] || @options[:ldap][:server]
+        
+    raise CASServer::AuthenticatorError, "The username '#{@username}' contains invalid characters." if (@username =~ /[*\(\)\0\/]/)
+    
+    preprocess_username
+    
+    @ldap = Net::LDAP.new
+    
+    
+    @options[:ldap][:host] ||= @options[:ldap][:server]
+    @ldap.host = @options[:ldap][:host]
+    @ldap.port = @options[:ldap][:port] if @options[:ldap][:port]
+    @ldap.encryption(@options[:ldap][:encryption].intern) if @options[:ldap][:encryption]
+    
+    begin
+      if @options[:ldap][:auth_user]
+        bind_success = bind_by_username_with_preauthentication
+      else
+        bind_success = bind_by_username
+      end
+      
+      return false unless bind_success
+      
+      entry = find_user
+      extract_extra_attributes(entry)
+      
+      return true
+    rescue Net::LDAP::LdapError => e
+      raise CASServer::AuthenticatorError,
+        "LDAP authentication failed with '#{e}'. Check your authenticator configuration."
+    end
+  end
+  
+  protected
+    def default_username_attribute
+      "cn"
+    end
+  
+  private
+    # Add prefix to username, if :username_prefix was specified in the :ldap config.
+    def preprocess_username
+      @username = @options[:ldap][:username_prefix] + @username if @options[:ldap][:username_prefix]
+    end
+
+    # Attempt to bind with the LDAP server using the username and password entered by
+    # the user. If a :filter was specified in the :ldap config, the filter will be
+    # added to the LDAP query for the username.
+    def bind_by_username
+      username_attribute = options[:ldap][:username_attribute] || default_username_attribute
+      
+      @ldap.bind_as(:base => @options[:ldap][:base], :password => @password, :filter => user_filter)
+    end
+
+    # If an auth_user is specified, we will connect ("pre-authenticate") with the
+    # LDAP server using the authenticator account, and then attempt to bind as the
+    # user who is actually trying to authenticate. Note that you need to set up 
+    # the special authenticator account first. Also, auth_user must be the authenticator
+    # user's full CN, which is probably not the same as their username.
+    #
+    # This pre-authentication process is necessary because binding can only be done
+    # using the CN, so having just the username is not enough. We connect as auth_user, 
+    # and then try to find the target user's CN based on the given username. Then we bind
+    # as the target user to validate their credentials.
+    def bind_by_username_with_preauthentication
+      raise CASServer::AuthenticatorError, "A password must be specified in the configuration for the authenticator user!" unless 
+        @options[:ldap][:auth_password]
+      
+      @ldap.authenticate(@options[:ldap][:auth_user], @options[:ldap][:auth_password])
+      
+      @ldap.bind_as(:base => @options[:ldap][:base], :password => @password, :filter => user_filter)
+    end
+  
+    # Combine the filter for finding the user with the optional extra filter specified in the config
+    # (if any).
+    def user_filter
+      username_attribute = options[:ldap][:username_attribute] || default_username_attribute
+      
+      filter = Net::LDAP::Filter.eq(username_attribute, @username)
+      unless @options[:ldap][:filter].blank?
+        filter &= Net::LDAP::Filter.construct(@options[:ldap][:filter])
+      end
+    end
+  
+    # Finds the user based on the user_filter (this is called after authentication).
+    # We do this to make it possible to extract extra_attributes.
+    def find_user
+      results = @ldap.search( :base => options[:ldap][:base], :filter => user_filter)
+      return results.first
+    end
+  
+    def extract_extra_attributes(ldap_entry)
+      @extra_attributes = {}
+      extra_attributes_to_extract.each do |attr|
+        v = !ldap_entry[attr].blank? && ldap_entry[attr].first
+        if v
+          @extra_attributes[attr] = v.to_s
+        end
+      end
+      
+      if @extra_attributes.empty?
+        $LOG.warn("#{self.class}: Did not read any extra_attributes for user #{@username.inspect} even though an :extra_attributes option was provided.")
+      else
+        $LOG.debug("#{self.class}: Read the following extra_attributes for user #{@username.inspect}: #{@extra_attributes.inspect}")
+      end
+      ldap_entry
+    end
+end

data/lib/casserver/authenticators/ntlm.rb

@@ -0,0 +1,88 @@
+# THIS AUTHENTICATOR DOES NOT WORK (not even close!)
+#
+# I started working on this but run into a wall, so I am commiting what I've got
+# done and leaving it here with hopes of one day finishing it.
+# 
+# The main problem is that although I've got the Lan Manager/NTLM password hash,
+# I'm not sure what to do with it. i.e. I need to check it against the AD or SMB
+# server or something... maybe faking an SMB share connection and using the LM
+# response for authentication might do the trick?
+
+require 'casserver/authenticators/base'
+
+# Ruby/NTLM package from RubyForge
+require 'net/ntlm'
+
+module CASServer
+  module Authenticators
+    class NTLM
+      # This will have to be somehow called by the top of the 'get' method
+      # in the Login controller (maybe via a hook?)... if this code fails
+      # then the controller should fall back to some other method of authentication
+      # (probably AD/LDAP or something).
+      def filter_for_top_of_login_get_controller_method
+        $LOG.debug @env.inspect
+        if @env['HTTP_AUTHORIZATION'] =~ /NTLM ([^\s]+)/
+          # if we're here, then the client has sent back a Type1 or Type3 message
+          # in reply to our NTLM challenge or our Type2 message
+          data_raw = Base64.decode64($~[1])
+          $LOG.debug "T1 RAW: #{t1_raw}"
+          t = Net::NTLM::Message::Message.parse(t1_raw)
+          if t.kind_of? Net::NTLM::Type1
+            t1 = t
+          elsif t.kind_of? Net::NTLM::Type3
+            t3 = t
+          else
+            raise "Invalid NTLM reply from client."
+          end
+          
+          if t1
+            $LOG.debug "T1: #{t1.inspect}"
+            
+            # now put together a Type2 message asking for the client to send
+            # back NTLM credentials (LM hash and such)
+            t2 = Net::NTLM::Message::Type2.new
+            t2.set_flag :UNICODE
+            t2.set_flag :NTLM
+            t2.context = 0x0000000000000000 # this can probably just be left unassigned
+            t2.challenge = 0x0123456789abcdef # this should be a random 8-byte integer
+            
+            $LOG.debug "T2: #{t2.inspect}"
+            $LOG.debug "T2: #{t2.serialize}"
+            headers["WWW-Authenticate"] = "NTLM #{t2.encode64}"
+            
+            # the client should respond to this with a Type3 message...
+            r('401', '', headers)
+            return
+          else
+            # NOTE: for some reason the server never receives the T3 response, even though monitoring
+            # the HTTP traffic I can see that the client does send it back... there's probably
+            # another bug hiding somewhere here
+          
+            lm_response = t3.lm_response
+            ntlm_response = t3.ntlm_response
+            username = t3.user
+            # this is where we run up against a wall... we need some way to check the lm and/or ntlm
+            # reponse against the authentication server (probably Active Directory)... maybe a samba
+            # call would do it?
+            $LOG.debug "T3 LM: #{lm_response.inspect}"
+            $LOG.debug "T3 NTLM: #{ntlm_response.inspect}"
+            
+            # assuming the authentication was successful, we'll now need to do something in the 
+            # controller acting as if we'd received correct login credentials (i.e. proceed as if
+            # CAS authentication was successful).... if authentication failed, then we should
+            # just fall back to old-school web-based authentication, asking the user to enter
+            # their username and password the normal CAS way
+          end
+        else
+          # this sends the initial NTLM challenge, asking the browser
+          # to send back a Type1 message
+          headers['WWW-Authenticate'] = "NTLM"
+          headers['Connection'] = "Close"
+          r('401', '', headers)
+          return
+        end
+      end
+    end
+  end
+end

data/lib/casserver/authenticators/open_id.rb

@@ -0,0 +1,22 @@
+require 'casserver/authenticators/base'
+
+require 'openid'
+require 'openid/extensions/sreg'
+require 'openid/extensions/pape'
+require 'openid/store/memory'
+
+
+# CURRENTLY UNIMPLEMENTED
+# This is just starter code.
+class CASServer::Authenticators::OpenID < CASServer::Authenticators::Base
+
+  def validate(credentials)
+    raise NotImplementedError, "The OpenID authenticator is not yet implemented. "+
+      "See http://code.google.com/p/rubycas-server/issues/detail?id=36 if you are interested in helping this along."
+    
+    read_standard_credentials(credentials)
+    
+    store = OpenID::Store::Memory.new
+    consumer = OpenID::Consumer.new({}, store)
+  end
+end

data/lib/casserver/authenticators/sql.rb

@@ -0,0 +1,102 @@
+require 'casserver/authenticators/base'
+
+begin
+  require 'active_record'
+rescue LoadError
+  require 'rubygems'
+  require 'active_record'
+end
+
+# Authenticates against a plain SQL table. 
+# 
+# This assumes that all of your users are stored in a table that has a 'username' 
+# column and a 'password' column. When the user logs in, CAS conects to the 
+# database and looks for a matching username/password in the users table. If a 
+# matching username and password is found, authentication is successful.
+#
+# Any database backend supported by ActiveRecord can be used.
+# 
+# Config example:
+#
+#   authenticator:
+#     class: CASServer::Authenticators::SQL
+#     database:
+#       adapter: mysql
+#       database: some_database_with_users_table
+#       username: root
+#       password: 
+#       server: localhost
+#     user_table: users
+#     username_column: username
+#     password_column: password
+#
+# When replying to a CAS client's validation request, the server will normally
+# provide the client with the authenticated user's username. However it is now
+# possible for the server to provide the client with additional attributes.
+# You can configure the SQL authenticator to provide data from additional
+# columns in the users table by listing the names of the columns under the 
+# 'extra_attributes' option. Note though that this functionality is experimental.
+# It should work with RubyCAS-Client, but may or may not work with other CAS
+# clients. 
+#
+# For example, with this configuration, the 'full_name' and 'access_level'
+# columns will be provided to your CAS clients along with the username:
+#
+#   authenticator:
+#     class: CASServer::Authenticators::SQL
+#     database:
+#       adapter: mysql
+#       database: some_database_with_users_table
+#     user_table: users
+#     username_column: username
+#     password_column: password
+#     extra_attributes: full_name, access_level
+# 
+class CASServer::Authenticators::SQL < CASServer::Authenticators::Base
+
+  def validate(credentials)
+    read_standard_credentials(credentials)
+    
+    raise CASServer::AuthenticatorError, "Cannot validate credentials because the authenticator hasn't yet been configured" unless @options
+    raise CASServer::AuthenticatorError, "Invalid authenticator configuration!" unless @options[:database]
+    
+    CASUser.establish_connection @options[:database]
+    CASUser.set_table_name @options[:user_table] || "users"
+    
+    username_column = @options[:username_column] || 'username'
+    password_column = @options[:password_column] || 'password'
+    
+    results = CASUser.find(:all, :conditions => ["#{username_column} = ? AND #{password_column} = ?", @username, @password])
+    
+    if results.size > 0
+      $LOG.warn("#{self.class}: Multiple matches found for user #{@username.inspect}") if results.size > 1
+      
+      unless @options[:extra_attributes].blank?
+        if results.size > 1
+          $LOG.warn("#{self.class}: Unable to extract extra_attributes because multiple matches were found for #{@username.inspect}")
+        else
+          user = results.first
+          
+          @extra_attributes = {}
+          extra_attributes_to_extract.each do |col|
+            @extra_attributes[col] = user.send(col)
+          end
+          
+          if @extra_attributes.empty?
+            $LOG.warn("#{self.class}: Did not read any extra_attributes for user #{@username.inspect} even though an :extra_attributes option was provided.")
+          else
+            $LOG.debug("#{self.class}: Read the following extra_attributes for user #{@username.inspect}: #{@extra_attributes.inspect}")
+          end
+        end
+      end
+      
+      return true
+    else
+      return false
+    end
+  end
+  
+  class CASUser < ActiveRecord::Base
+  end
+
+end

data/lib/casserver/authenticators/sql_encrypted.rb

@@ -0,0 +1,75 @@
+require 'casserver/authenticators/base'
+
+require 'digest/sha1'
+require 'digest/sha2'
+
+$: << File.dirname(File.expand_path(__FILE__)) + "/../../../vendor/isaac_0.9.1"
+require 'crypt/ISAAC'
+
+begin
+  require 'active_record'
+rescue LoadError
+  require 'rubygems'
+  require 'active_record'
+end
+
+# This is a more secure version of the SQL authenticator. Passwords are encrypted 
+# rather than being stored in plain text.
+#
+# Based on code contributed by Ben Mabey.
+#
+# Using this authenticator requires some configuration on the client side. Please see
+# http://code.google.com/p/rubycas-server/wiki/UsingTheSQLEncryptedAuthenticator
+class CASServer::Authenticators::SQLEncrypted < CASServer::Authenticators::Base
+
+  def validate(credentials)
+    read_standard_credentials(credentials)
+    
+    raise CASServer::AuthenticatorError, "Cannot validate credentials because the authenticator hasn't yet been configured" unless @options
+    raise CASServer::AuthenticatorError, "Invalid authenticator configuration!" unless @options[:database]
+    
+    CASUser.establish_connection @options[:database]
+    CASUser.set_table_name @options[:user_table] || "users"
+    
+    username_column = @options[:username_column] || "username"
+    
+    results = CASUser.find(:all, :conditions => ["#{username_column} = ?", @username])
+    
+    if results.size > 0
+      $LOG.warn("Multiple matches found for user '#{@username}'") if results.size > 1
+      user = results.first
+      return user.encrypted_password == user.encrypt(@password)
+    else
+      return false
+    end
+  end
+  
+  # Include this module into your application's user model. 
+  #
+  # Your model must have an 'encrypted_password' column where the password will be stored,
+  # and an 'encryption_salt' column that will be populated with a random string before
+  # the user record is first created.
+  module EncryptedPassword
+    def self.included(mod)
+      raise "#{self} should be inclued in an ActiveRecord class!" unless mod.respond_to?(:before_save)
+      mod.before_save :generate_encryption_salt
+    end
+    
+    def encrypt(str)
+      Digest::SHA256.hexdigest("#{encryption_salt}::#{str}")
+    end
+    
+    def password=(password)
+      self[:encrypted_password] = encrypt(password)
+    end
+    
+    def generate_encryption_salt
+      self.encryption_salt = Digest::SHA1.hexdigest(Crypt::ISAAC.new.rand(2**31).to_s) unless
+        encryption_salt
+    end
+  end
+  
+  class CASUser < ActiveRecord::Base
+    include EncryptedPassword
+  end
+end

data/lib/casserver/authenticators/sql_md5.rb

@@ -0,0 +1,19 @@
+require 'casserver/authenticators/sql'
+
+require 'digest/md5'
+
+# Essentially the same as the standard SQL authenticator, but this version
+# assumes that your password is stored as an MD5 hash.
+#
+# This was contributed by malcomm for Drupal authentication. To work with
+# Drupal, you should use 'name' for the :username_column config option, and
+# 'pass' for the :password_column.
+class CASServer::Authenticators::SQLMd5 < CASServer::Authenticators::SQL
+  
+  protected
+    def read_standard_credentials(credentials)
+      super
+      @password = Digest::MD5.hexdigest(@password)
+    end
+
+end

data/lib/casserver/authenticators/test.rb

@@ -0,0 +1,19 @@
+require 'casserver/authenticators/base'
+
+# Dummy authenticator used for testing. 
+# Accepts "testuser" for username and "testpassword" for password; otherwise authentication fails.
+# Raises an AuthenticationError when username is "do_error" (this is useful to test the Exception
+# handling functionality).
+class CASServer::Authenticators::Test < CASServer::Authenticators::Base
+  def validate(credentials)
+    read_standard_credentials(credentials)
+    
+    raise CASServer::AuthenticatorError, "Username is 'do_error'!" if @username == 'do_error'
+    
+    @extra_attributes[:test_string] = "testing!"
+    @extra_attributes[:test_numeric] = 123.45
+    @extra_attributes[:test_serialized] = {:foo => 'bar', :alpha => [1,2,3]}
+    
+    return @password == "testpassword"
+  end
+end