jro_apps/redmine Commit - r8791:3e3d7c8d4f4f

Friendly response when the LDAP connection fails....

Jean-Philippe Lang -

r8791:3e3d7c8d4f4f

parent child

Context file:

r8791:3e3d7c8d4f4f

Collapse all files

app/controllers/account_controller.rb +3 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class AccountController < ApplicationController
               helper :custom_fields
               include CustomFieldsHelper
               # prevents login action to be filtered by check_if_login_required application scope filter
               skip_before_filter :check_if_login_required
               # Login request and validation
               def login
                 if request.get?
                   logout_user
                 else
                   authenticate_user
                 end
+              rescue AuthSourceException => e
+                logger.error "An error occured when authenticating #{params[:username]}: #{e.message}"
+                render_error :message => e.message
               end
               # Log out current user and redirect to welcome page
               def logout
                 logout_user
                 redirect_to home_url
               end
               # Enable user to choose a new password
               def lost_password
                 redirect_to(home_url) && return unless Setting.lost_password?
                 if params[:token]
                   @token = Token.find_by_action_and_value("recovery", params[:token])
                   redirect_to(home_url) && return unless @token and !@token.expired?
                   @user = @token.user
                   if request.post?
                     @user.password, @user.password_confirmation = params[:new_password], params[:new_password_confirmation]
                     if @user.save
                       @token.destroy
                       flash[:notice] = l(:notice_account_password_updated)
                       redirect_to :action => 'login'
                       return
                     end
                   end
                   render :template => "account/password_recovery"
                   return
                 else
                   if request.post?
                     user = User.find_by_mail(params[:mail])
                     # user not found in db
                     (flash.now[:error] = l(:notice_account_unknown_email); return) unless user
                     # user uses an external authentification
                     (flash.now[:error] = l(:notice_can_t_change_password); return) if user.auth_source_id
                     # create a new token for password recovery
                     token = Token.new(:user => user, :action => "recovery")
                     if token.save
                       Mailer.deliver_lost_password(token)
                       flash[:notice] = l(:notice_account_lost_email_sent)
                       redirect_to :action => 'login'
                       return
                     end
                   end
                 end
               end
               # User self-registration
               def register
                 redirect_to(home_url) && return unless Setting.self_registration? || session[:auth_source_registration]
                 if request.get?
                   session[:auth_source_registration] = nil
                   @user = User.new(:language => Setting.default_language)
                 else
                   @user = User.new
                   @user.safe_attributes = params[:user]
                   @user.admin = false
                   @user.register
                   if session[:auth_source_registration]
                     @user.activate
                     @user.login = session[:auth_source_registration][:login]
                     @user.auth_source_id = session[:auth_source_registration][:auth_source_id]
                     if @user.save
                       session[:auth_source_registration] = nil
                       self.logged_user = @user
                       flash[:notice] = l(:notice_account_activated)
                       redirect_to :controller => 'my', :action => 'account'
                     end
                   else
                     @user.login = params[:user][:login]
                     @user.password, @user.password_confirmation = params[:user][:password], params[:user][:password_confirmation]
                     case Setting.self_registration
                     when '1'
                       register_by_email_activation(@user)
                     when '3'
                       register_automatically(@user)
                     else
                       register_manually_by_administrator(@user)
                     end
                   end
                 end
               end
               # Token based account activation
               def activate
                 redirect_to(home_url) && return unless Setting.self_registration? && params[:token]
                 token = Token.find_by_action_and_value('register', params[:token])
                 redirect_to(home_url) && return unless token and !token.expired?
                 user = token.user
                 redirect_to(home_url) && return unless user.registered?
                 user.activate
                 if user.save
                   token.destroy
                   flash[:notice] = l(:notice_account_activated)
                 end
                 redirect_to :action => 'login'
               end
               private
               def logout_user
                 if User.current.logged?
                   cookies.delete :autologin
                   Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin'])
                   self.logged_user = nil
                 end
               end
               def authenticate_user
                 if Setting.openid? && using_open_id?
                   open_id_authenticate(params[:openid_url])
                 else
                   password_authentication
                 end
               end
               def password_authentication
                 user = User.try_to_login(params[:username], params[:password])
                 if user.nil?
                   invalid_credentials
                 elsif user.new_record?
                   onthefly_creation_failed(user, {:login => user.login, :auth_source_id => user.auth_source_id })
                 else
                   # Valid user
                   successful_authentication(user)
                 end
               end
               def open_id_authenticate(openid_url)
                 authenticate_with_open_id(openid_url, :required => [:nickname, :fullname, :email], :return_to => signin_url) do |result, identity_url, registration|
                   if result.successful?
                     user = User.find_or_initialize_by_identity_url(identity_url)
                     if user.new_record?
                       # Self-registration off
                       redirect_to(home_url) && return unless Setting.self_registration?
                       # Create on the fly
                       user.login = registration['nickname'] unless registration['nickname'].nil?
                       user.mail = registration['email'] unless registration['email'].nil?
                       user.firstname, user.lastname = registration['fullname'].split(' ') unless registration['fullname'].nil?
                       user.random_password
                       user.register
                       case Setting.self_registration
                       when '1'
                         register_by_email_activation(user) do
                           onthefly_creation_failed(user)
                         end
                       when '3'
                         register_automatically(user) do
                           onthefly_creation_failed(user)
                         end
                       else
                         register_manually_by_administrator(user) do
                           onthefly_creation_failed(user)
                         end
                       end
                     else
                       # Existing record
                       if user.active?
                         successful_authentication(user)
                       else
                         account_pending
                       end
                     end
                   end
                 end
               end
               def successful_authentication(user)
                 # Valid user
                 self.logged_user = user
                 # generate a key and set cookie if autologin
                 if params[:autologin] && Setting.autologin?
                   set_autologin_cookie(user)
                 end
                 call_hook(:controller_account_success_authentication_after, {:user => user })
                 redirect_back_or_default :controller => 'my', :action => 'page'
               end
               def set_autologin_cookie(user)
                 token = Token.create(:user => user, :action => 'autologin')
                 cookie_name = Redmine::Configuration['autologin_cookie_name'] || 'autologin'
                 cookie_options = {
                   :value => token.value,
                   :expires => 1.year.from_now,
                   :path => (Redmine::Configuration['autologin_cookie_path'] || '/'),
                   :secure => (Redmine::Configuration['autologin_cookie_secure'] ? true : false),
                   :httponly => true
                 }
                 cookies[cookie_name] = cookie_options
               end
               # Onthefly creation failed, display the registration form to fill/fix attributes
               def onthefly_creation_failed(user, auth_source_options = { })
                 @user = user
                 session[:auth_source_registration] = auth_source_options unless auth_source_options.empty?
                 render :action => 'register'
               end
               def invalid_credentials
                 logger.warn "Failed login for '#{params[:username]}' from #{request.remote_ip} at #{Time.now.utc}"
                 flash.now[:error] = l(:notice_account_invalid_creditentials)
               end
               # Register a user for email activation.
               #
               # Pass a block for behavior when a user fails to save
               def register_by_email_activation(user, &block)
                 token = Token.new(:user => user, :action => "register")
                 if user.save and token.save
                   Mailer.deliver_register(token)
                   flash[:notice] = l(:notice_account_register_done)
                   redirect_to :action => 'login'
                 else
                   yield if block_given?
                 end
               end
               # Automatically register a user
               #
               # Pass a block for behavior when a user fails to save
               def register_automatically(user, &block)
                 # Automatic activation
                 user.activate
                 user.last_login_on = Time.now
                 if user.save
                   self.logged_user = user
                   flash[:notice] = l(:notice_account_activated)
                   redirect_to :controller => 'my', :action => 'account'
                 else
                   yield if block_given?
                 end
               end
               # Manual activation by the administrator
               #
               # Pass a block for behavior when a user fails to save
               def register_manually_by_administrator(user, &block)
                 if user.save
                   # Sends an email to the administrators
                   Mailer.deliver_account_activation_request(user)
                   account_pending
                 else
                   yield if block_given?
                 end
               end
               def account_pending
                 flash[:notice] = l(:notice_account_pending)
                 redirect_to :action => 'login'
               end
             end

app/models/auth_source.rb +4 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+            # Generic exception for when the AuthSource can not be reached
+            # (eg. can not connect to the LDAP)
+            class AuthSourceException < Exception; end
             class AuthSource < ActiveRecord::Base
               include Redmine::Ciphering
               has_many :users
               validates_presence_of :name
               validates_uniqueness_of :name
               validates_length_of :name, :maximum => 60
               def authenticate(login, password)
               end
               def test_connection
               end
               def auth_method_name
                 "Abstract"
               end
               def account_password
                 read_ciphered_attribute(:account_password)
               end
               def account_password=(arg)
                 write_ciphered_attribute(:account_password, arg)
               end
               def allow_password_changes?
                 self.class.allow_password_changes?
               end
               # Does this auth source backend allow password changes?
               def self.allow_password_changes?
                 false
               end
               # Try to authenticate a user not yet registered against available sources
               def self.authenticate(login, password)
                 AuthSource.find(:all, :conditions => ["onthefly_register=?", true]).each do |source|
                   begin
                     logger.debug "Authenticating '#{login}' against '#{source.name}'" if logger && logger.debug?
                     attrs = source.authenticate(login, password)
                   rescue => e
                     logger.error "Error during authentication: #{e.message}"
                     attrs = nil
                   end
                   return attrs if attrs
                 end
                 return nil
               end
             end

app/models/auth_source_ldap.rb +2 -2

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'iconv'
             require 'net/ldap'
             class AuthSourceLdap < AuthSource
               validates_presence_of :host, :port, :attr_login
               validates_length_of :name, :host, :maximum => 60, :allow_nil => true
               validates_length_of :account, :account_password, :base_dn, :maximum => 255, :allow_nil => true
               validates_length_of :attr_login, :attr_firstname, :attr_lastname, :attr_mail, :maximum => 30, :allow_nil => true
               validates_numericality_of :port, :only_integer => true
               before_validation :strip_ldap_attributes
               def initialize(attributes=nil, *args)
                 super
                 self.port = 389 if self.port == 0
               end
               def authenticate(login, password)
                 return nil if login.blank? || password.blank?
                 attrs = get_user_dn(login)
                 if attrs && attrs[:dn] && authenticate_dn(attrs[:dn], password)
                   logger.debug "Authentication successful for '#{login}'" if logger && logger.debug?
                   return attrs.except(:dn)
                 end
-              rescue  Net::LDAP::LdapError => text
+              rescue  Net::LDAP::LdapError => e
-                raise "LdapError: " + text
+                raise AuthSourceException.new(e.message)
               end
               # test the connection to the LDAP
               def test_connection
                 ldap_con = initialize_ldap_con(self.account, self.account_password)
                 ldap_con.open { }
               rescue  Net::LDAP::LdapError => text
                 raise "LdapError: " + text
               end
               def auth_method_name
                 "LDAP"
               end
               private
               def strip_ldap_attributes
                 [:attr_login, :attr_firstname, :attr_lastname, :attr_mail].each do |attr|
                   write_attribute(attr, read_attribute(attr).strip) unless read_attribute(attr).nil?
                 end
               end
               def initialize_ldap_con(ldap_user, ldap_password)
                 options = { :host => self.host,
                             :port => self.port,
                             :encryption => (self.tls ? :simple_tls : nil)
                           }
                 options.merge!(:auth => { :method => :simple, :username => ldap_user, :password => ldap_password }) unless ldap_user.blank? && ldap_password.blank?
                 Net::LDAP.new options
               end
               def get_user_attributes_from_ldap_entry(entry)
                 {
                  :dn => entry.dn,
                  :firstname => AuthSourceLdap.get_attr(entry, self.attr_firstname),
                  :lastname => AuthSourceLdap.get_attr(entry, self.attr_lastname),
                  :mail => AuthSourceLdap.get_attr(entry, self.attr_mail),
                  :auth_source_id => self.id
                 }
               end
               # Return the attributes needed for the LDAP search.  It will only
               # include the user attributes if on-the-fly registration is enabled
               def search_attributes
                 if onthefly_register?
                   ['dn', self.attr_firstname, self.attr_lastname, self.attr_mail]
                 else
                   ['dn']
                 end
               end
               # Check if a DN (user record) authenticates with the password
               def authenticate_dn(dn, password)
                 if dn.present? && password.present?
                   initialize_ldap_con(dn, password).bind
                 end
               end
               # Get the user's dn and any attributes for them, given their login
               def get_user_dn(login)
                 ldap_con = initialize_ldap_con(self.account, self.account_password)
                 login_filter = Net::LDAP::Filter.eq( self.attr_login, login )
                 object_filter = Net::LDAP::Filter.eq( "objectClass", "*" )
                 attrs = {}
                 ldap_con.search( :base => self.base_dn,
                                  :filter => object_filter & login_filter,
                                  :attributes=> search_attributes) do |entry|
                   if onthefly_register?
                     attrs = get_user_attributes_from_ldap_entry(entry)
                   else
                     attrs = {:dn => entry.dn}
                   end
                   logger.debug "DN found for #{login}: #{attrs[:dn]}" if logger && logger.debug?
                 end
                 attrs
               end
               def self.get_attr(entry, attr_name)
                 if !attr_name.blank?
                   entry[attr_name].is_a?(Array) ? entry[attr_name].first : entry[attr_name]
                 end
               end
             end

test/functional/account_controller_test.rb +10 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../test_helper', __FILE__)
             require 'account_controller'
             # Re-raise errors caught by the controller.
             class AccountController; def rescue_action(e) raise e end; end
             class AccountControllerTest < ActionController::TestCase
               fixtures :users, :roles
               def setup
                 @controller = AccountController.new
                 @request    = ActionController::TestRequest.new
                 @response   = ActionController::TestResponse.new
                 User.current = nil
               end
               def test_login_should_redirect_to_back_url_param
                 # request.uri is "test.host" in test environment
                 post :login, :username => 'jsmith', :password => 'jsmith', :back_url => 'http%3A%2F%2Ftest.host%2Fissues%2Fshow%2F1'
                 assert_redirected_to '/issues/show/1'
               end
               def test_login_should_not_redirect_to_another_host
                 post :login, :username => 'jsmith', :password => 'jsmith', :back_url => 'http%3A%2F%2Ftest.foo%2Ffake'
                 assert_redirected_to '/my/page'
               end
               def test_login_with_wrong_password
                 post :login, :username => 'admin', :password => 'bad'
                 assert_response :success
                 assert_template 'login'
                 assert_tag 'div',
                            :attributes => { :class => "flash error" },
                            :content => /Invalid user or password/
               end
+              def test_login_should_rescue_auth_source_exception
+                source = AuthSource.create!(:name => 'Test')
+                User.find(2).update_attribute :auth_source_id, source.id
+                AuthSource.any_instance.stubs(:authenticate).raises(AuthSourceException.new("Something wrong"))
+                post :login, :username => 'jsmith', :password => 'jsmith'
+                assert_response 500
+                assert_error_tag :content => /Something wrong/
+              end
               if Object.const_defined?(:OpenID)
               def test_login_with_openid_for_existing_user
                 Setting.self_registration = '3'
                 Setting.openid = '1'
                 existing_user = User.new(:firstname => 'Cool',
                                          :lastname => 'User',
                                          :mail => 'user@somedomain.com',
                                          :identity_url => 'http://openid.example.com/good_user')
                 existing_user.login = 'cool_user'
                 assert existing_user.save!
                 post :login, :openid_url => existing_user.identity_url
                 assert_redirected_to '/my/page'
               end
               def test_login_with_invalid_openid_provider
                 Setting.self_registration = '0'
                 Setting.openid = '1'
                 post :login, :openid_url => 'http;//openid.example.com/good_user'
                 assert_redirected_to home_url
               end
               def test_login_with_openid_for_existing_non_active_user
                 Setting.self_registration = '2'
                 Setting.openid = '1'
                 existing_user = User.new(:firstname => 'Cool',
                                          :lastname => 'User',
                                          :mail => 'user@somedomain.com',
                                          :identity_url => 'http://openid.example.com/good_user',
                                          :status => User::STATUS_REGISTERED)
                 existing_user.login = 'cool_user'
                 assert existing_user.save!
                 post :login, :openid_url => existing_user.identity_url
                 assert_redirected_to '/login'
               end
               def test_login_with_openid_with_new_user_created
                 Setting.self_registration = '3'
                 Setting.openid = '1'
                 post :login, :openid_url => 'http://openid.example.com/good_user'
                 assert_redirected_to '/my/account'
                 user = User.find_by_login('cool_user')
                 assert user
                 assert_equal 'Cool', user.firstname
                 assert_equal 'User', user.lastname
               end
               def test_login_with_openid_with_new_user_and_self_registration_off
                 Setting.self_registration = '0'
                 Setting.openid = '1'
                 post :login, :openid_url => 'http://openid.example.com/good_user'
                 assert_redirected_to home_url
                 user = User.find_by_login('cool_user')
                 assert ! user
               end
               def test_login_with_openid_with_new_user_created_with_email_activation_should_have_a_token
                 Setting.self_registration = '1'
                 Setting.openid = '1'
                 post :login, :openid_url => 'http://openid.example.com/good_user'
                 assert_redirected_to '/login'
                 user = User.find_by_login('cool_user')
                 assert user
                 token = Token.find_by_user_id_and_action(user.id, 'register')
                 assert token
               end
               def test_login_with_openid_with_new_user_created_with_manual_activation
                 Setting.self_registration = '2'
                 Setting.openid = '1'
                 post :login, :openid_url => 'http://openid.example.com/good_user'
                 assert_redirected_to '/login'
                 user = User.find_by_login('cool_user')
                 assert user
                 assert_equal User::STATUS_REGISTERED, user.status
               end
               def test_login_with_openid_with_new_user_with_conflict_should_register
                 Setting.self_registration = '3'
                 Setting.openid = '1'
                 existing_user = User.new(:firstname => 'Cool', :lastname => 'User', :mail => 'user@somedomain.com')
                 existing_user.login = 'cool_user'
                 assert existing_user.save!
                 post :login, :openid_url => 'http://openid.example.com/good_user'
                 assert_response :success
                 assert_template 'register'
                 assert assigns(:user)
                 assert_equal 'http://openid.example.com/good_user', assigns(:user)[:identity_url]
               end
               def test_setting_openid_should_return_true_when_set_to_true
                 Setting.openid = '1'
                 assert_equal true, Setting.openid?
               end
               else
                 puts "Skipping openid tests."
               end
               def test_logout
                 @request.session[:user_id] = 2
                 get :logout
                 assert_redirected_to '/'
                 assert_nil @request.session[:user_id]
               end
               def test_get_register_with_registration_on
                 with_settings :self_registration => '3' do
                   get :register
                   assert_response :success
                   assert_template 'register'
                   assert_not_nil assigns(:user)
                   assert_tag 'input', :attributes => {:name => 'user[password]'}
                   assert_tag 'input', :attributes => {:name => 'user[password_confirmation]'}
                 end
               end
               def test_get_register_with_registration_off_should_redirect
                 with_settings :self_registration => '0' do
                   get :register
                   assert_redirected_to '/'
                 end
               end
               # See integration/account_test.rb for the full test
               def test_post_register_with_registration_on
                 with_settings :self_registration => '3' do
                   assert_difference 'User.count' do
                     post :register, :user => {
                       :login => 'register',
                       :password => 'test',
                       :password_confirmation => 'test',
                       :firstname => 'John',
                       :lastname => 'Doe',
                       :mail => 'register@example.com'
                     }
                     assert_redirected_to '/my/account'
                   end
                   user = User.first(:order => 'id DESC')
                   assert_equal 'register', user.login
                   assert_equal 'John', user.firstname
                   assert_equal 'Doe', user.lastname
                   assert_equal 'register@example.com', user.mail
                   assert user.check_password?('test')
                   assert user.active?
                 end
               end
               def test_post_register_with_registration_off_should_redirect
                 with_settings :self_registration => '0' do
                   assert_no_difference 'User.count' do
                     post :register, :user => {
                       :login => 'register',
                       :password => 'test',
                       :password_confirmation => 'test',
                       :firstname => 'John',
                       :lastname => 'Doe',
                       :mail => 'register@example.com'
                     }
                     assert_redirected_to '/'
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages