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