jro_apps/redmine Commit - r3325:b3330d399543

Refactor: Extract method from AuthSourceLdap#authenticate...

Eric Davis -

r3325:b3330d399543

parent child

Context file:

r3325:b3330d399543

Collapse all files

app/models/auth_source_ldap.rb +11 -4

             # redMine - project management software
             # Copyright (C) 2006  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 'net/ldap'
             require 'iconv'
             class AuthSourceLdap < AuthSource
               validates_presence_of :host, :port, :attr_login
               validates_length_of :name, :host, :account_password, :maximum => 60, :allow_nil => true
               validates_length_of :account, :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 after_initialize
                 self.port = 389 if self.port == 0
               end
               def authenticate(login, password)
                 return nil if login.blank? || password.blank?
                 attrs = []
                 # get user's DN
                 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", "*" )
                 dn = String.new
                 ldap_con.search( :base => self.base_dn,
                                  :filter => object_filter & login_filter,
                                  # only ask for the DN if on-the-fly registration is disabled
                                  :attributes=> (onthefly_register? ? ['dn', self.attr_firstname, self.attr_lastname, self.attr_mail] : ['dn'])) do |entry|
                   dn = entry.dn
-                  attrs = [:firstname => AuthSourceLdap.get_attr(entry, self.attr_firstname),
+                  attrs = get_user_attributes_from_ldap_entry(entry) if onthefly_register?
-                           :lastname => AuthSourceLdap.get_attr(entry, self.attr_lastname),
-                           :mail => AuthSourceLdap.get_attr(entry, self.attr_mail),
-                           :auth_source_id => self.id ] if onthefly_register?
                 end
                 return nil if dn.empty?
                 logger.debug "DN found for #{login}: #{dn}" if logger && logger.debug?
                 # authenticate user
                 ldap_con = initialize_ldap_con(dn, password)
                 return nil unless ldap_con.bind
                 # return user's attributes
                 logger.debug "Authentication successful for '#{login}'" if logger && logger.debug?
                 attrs
               rescue  Net::LDAP::LdapError => text
                 raise "LdapError: " + text
               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)
+                [
+                 :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
               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/unit/auth_source_ldap_test.rb +6 -3

             # Redmine - project management software
             # Copyright (C) 2006-2008  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.dirname(__FILE__) + '/../test_helper'
             class AuthSourceLdapTest < ActiveSupport::TestCase
               def setup
               end
               def test_create
                 a = AuthSourceLdap.new(:name => 'My LDAP', :host => 'ldap.example.net', :port => 389, :base_dn => 'dc=example,dc=net', :attr_login => 'sAMAccountName')
                 assert a.save
               end
               def test_should_strip_ldap_attributes
                 a = AuthSourceLdap.new(:name => 'My LDAP', :host => 'ldap.example.net', :port => 389, :base_dn => 'dc=example,dc=net', :attr_login => 'sAMAccountName',
                                        :attr_firstname => 'givenName ')
                 assert a.save
                 assert_equal 'givenName', a.reload.attr_firstname
               end
               if ldap_configured?
                 context '#authenticate' do
                   setup do
                     @auth = AuthSourceLdap.generate!(:name => 'on the fly',
                                                      :host => '127.0.0.1',
                                                      :port => 389,
                                                      :base_dn => 'OU=Person,DC=redmine,DC=org',
                                                      :attr_login => 'uid',
                                                      :attr_firstname => 'givenName',
                                                      :attr_lastname => 'sn',
                                                      :attr_mail => 'mail',
                                                      :onthefly_register => true)
                   end
                   context 'with a valid LDAP user' do
                     should 'return the firstname user attributes' do
                       response =  @auth.authenticate('example1','123456')
-                      assert response
+                      assert response.is_a?(Array), "An array was not returned"
+                      assert response.first.present?, "No user data returned"
                       assert_equal 'Example', response.first[:firstname]
                     end
                     should 'return the lastname user attributes' do
                       response =  @auth.authenticate('example1','123456')
-                      assert response
+                      assert response.is_a?(Array), "An array was not returned"
+                      assert response.first.present?, "No user data returned"
                       assert_equal 'One', response.first[:lastname]
                     end
                     should 'return mail user attributes' do
                       response =  @auth.authenticate('example1','123456')
-                      assert response
+                      assert response.is_a?(Array), "An array was not returned"
+                      assert response.first.present?, "No user data returned"
                       assert_equal 'example1@redmine.org', response.first[:mail]
                     end
                   end
                   context 'with an invalid LDAP user' do
                     should 'return nil' do
                       assert_equal nil, @auth.authenticate('nouser','123456')
                     end
                   end
                   context 'without a login' do
                     should 'return nil' do
                       assert_equal nil, @auth.authenticate('','123456')
                     end
                   end
                   context 'without a password' do
                     should 'return nil' do
                       assert_equal nil, @auth.authenticate('edavis','')
                     end
                   end
                 end
               else
                 puts '(Test LDAP server not configured)'
               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