auth_source_ldap.rb
209 lines
| 6.8 KiB
| text/x-ruby
|
RubyLexer
Toshi MARUYAMA
|
r6392 | # Redmine - project management software | ||
Jean-Philippe Lang
|
r14856 | # Copyright (C) 2006-2016 Jean-Philippe Lang | ||
|
Jean-Philippe Lang
|
r330 | # | ||
| # 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. | ||||
|
Toshi MARUYAMA
|
r6392 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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. | ||||
|
Toshi MARUYAMA
|
r6392 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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. | ||||
|
Jean-Philippe Lang
|
r8787 | require 'net/ldap' | ||
|
Jean-Philippe Lang
|
r9121 | require 'net/ldap/dn' | ||
|
Jean-Philippe Lang
|
r9748 | require 'timeout' | ||
|
Jean-Philippe Lang
|
r330 | |||
|
Toshi MARUYAMA
|
r6392 | class AuthSourceLdap < AuthSource | ||
|
Jean-Philippe Lang
|
r14426 | NETWORK_EXCEPTIONS = [ | ||
|
Toshi MARUYAMA
|
r15940 | Net::LDAP::Error, | ||
|
Jean-Philippe Lang
|
r14426 | Errno::ECONNABORTED, Errno::ECONNREFUSED, Errno::ECONNRESET, | ||
| Errno::EHOSTDOWN, Errno::EHOSTUNREACH, | ||||
| SocketError | ||||
| ] | ||||
|
Jean-Philippe Lang
|
r330 | validates_presence_of :host, :port, :attr_login | ||
|
Jean-Philippe Lang
|
r4830 | validates_length_of :name, :host, :maximum => 60, :allow_nil => true | ||
|
Jean-Philippe Lang
|
r14343 | validates_length_of :account, :account_password, :base_dn, :maximum => 255, :allow_blank => true | ||
|
Jean-Philippe Lang
|
r1661 | validates_length_of :attr_login, :attr_firstname, :attr_lastname, :attr_mail, :maximum => 30, :allow_nil => true | ||
| validates_numericality_of :port, :only_integer => true | ||||
|
Jean-Philippe Lang
|
r9748 | validates_numericality_of :timeout, :only_integer => true, :allow_blank => true | ||
|
Jean-Philippe Lang
|
r8924 | validate :validate_filter | ||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r1892 | before_validation :strip_ldap_attributes | ||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r8168 | def initialize(attributes=nil, *args) | ||
| super | ||||
|
Jean-Philippe Lang
|
r330 | self.port = 389 if self.port == 0 | ||
| end | ||||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r330 | def authenticate(login, password) | ||
|
Jean-Philippe Lang
|
r1155 | return nil if login.blank? || password.blank? | ||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r9748 | with_timeout do | ||
| attrs = get_user_dn(login, password) | ||||
| if attrs && attrs[:dn] && authenticate_dn(attrs[:dn], password) | ||||
| logger.debug "Authentication successful for '#{login}'" if logger && logger.debug? | ||||
| return attrs.except(:dn) | ||||
| end | ||||
Eric Davis
|
r3327 | end | ||
|
Jean-Philippe Lang
|
r14426 | rescue *NETWORK_EXCEPTIONS => e | ||
|
Jean-Philippe Lang
|
r8791 | raise AuthSourceException.new(e.message) | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r14704 | # Test the connection to the LDAP | ||
|
Jean-Philippe Lang
|
r330 | def test_connection | ||
|
Jean-Philippe Lang
|
r9748 | with_timeout do | ||
| ldap_con = initialize_ldap_con(self.account, self.account_password) | ||||
| ldap_con.open { } | ||||
|
Jean-Philippe Lang
|
r14704 | |||
|
Jean-Philippe Lang
|
r14708 | if self.account.present? && !self.account.include?("$login") && self.account_password.present? | ||
|
Jean-Philippe Lang
|
r14704 | ldap_auth = authenticate_dn(self.account, self.account_password) | ||
| raise AuthSourceException.new(l(:error_ldap_bind_credentials)) if !ldap_auth | ||||
| end | ||||
|
Jean-Philippe Lang
|
r9748 | end | ||
|
Jean-Philippe Lang
|
r14426 | rescue *NETWORK_EXCEPTIONS => e | ||
|
Jean-Philippe Lang
|
r9748 | raise AuthSourceException.new(e.message) | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r330 | def auth_method_name | ||
| "LDAP" | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r10850 | # Returns true if this source can be searched for users | ||
| def searchable? | ||||
| !account.to_s.include?("$login") && %w(login firstname lastname mail).all? {|a| send("attr_#{a}?")} | ||||
| end | ||||
| # Searches the source for users and returns an array of results | ||||
| def search(q) | ||||
| q = q.to_s.strip | ||||
| return [] unless searchable? && q.present? | ||||
| results = [] | ||||
| search_filter = base_filter & Net::LDAP::Filter.begins(self.attr_login, q) | ||||
| ldap_con = initialize_ldap_con(self.account, self.account_password) | ||||
| ldap_con.search(:base => self.base_dn, | ||||
| :filter => search_filter, | ||||
| :attributes => ['dn', self.attr_login, self.attr_firstname, self.attr_lastname, self.attr_mail], | ||||
| :size => 10) do |entry| | ||||
| attrs = get_user_attributes_from_ldap_entry(entry) | ||||
| attrs[:login] = AuthSourceLdap.get_attr(entry, self.attr_login) | ||||
| results << attrs | ||||
| end | ||||
| results | ||||
|
Jean-Philippe Lang
|
r14426 | rescue *NETWORK_EXCEPTIONS => e | ||
|
Jean-Philippe Lang
|
r10850 | raise AuthSourceException.new(e.message) | ||
| end | ||||
|
Jean-Philippe Lang
|
r1892 | private | ||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r9748 | def with_timeout(&block) | ||
| timeout = self.timeout | ||||
| timeout = 20 unless timeout && timeout > 0 | ||||
| Timeout.timeout(timeout) do | ||||
| return yield | ||||
| end | ||||
| rescue Timeout::Error => e | ||||
| raise AuthSourceTimeoutException.new(e.message) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r8924 | def ldap_filter | ||
| if filter.present? | ||||
| Net::LDAP::Filter.construct(filter) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r15940 | rescue Net::LDAP::Error, Net::LDAP::FilterSyntaxInvalidError | ||
|
Jean-Philippe Lang
|
r8924 | nil | ||
| end | ||||
|
Jean-Philippe Lang
|
r10850 | def base_filter | ||
| filter = Net::LDAP::Filter.eq("objectClass", "*") | ||||
| if f = ldap_filter | ||||
| filter = filter & f | ||||
| end | ||||
| filter | ||||
| end | ||||
|
Jean-Philippe Lang
|
r8924 | def validate_filter | ||
| if filter.present? && ldap_filter.nil? | ||||
| errors.add(:filter, :invalid) | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1892 | 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 | ||||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r330 | def initialize_ldap_con(ldap_user, ldap_password) | ||
|
Jean-Philippe Lang
|
r1180 | options = { :host => self.host, | ||
| :port => self.port, | ||||
| :encryption => (self.tls ? :simple_tls : nil) | ||||
| } | ||||
|
Jean-Philippe Lang
|
r1185 | options.merge!(:auth => { :method => :simple, :username => ldap_user, :password => ldap_password }) unless ldap_user.blank? && ldap_password.blank? | ||
|
Jean-Philippe Lang
|
r1180 | Net::LDAP.new options | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Eric Davis
|
r3325 | |||
| def get_user_attributes_from_ldap_entry(entry) | ||||
|
Jean-Philippe Lang
|
r3378 | { | ||
|
Eric Davis
|
r3340 | :dn => entry.dn, | ||
|
Eric Davis
|
r3325 | :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 | ||||
|
Jean-Philippe Lang
|
r3378 | } | ||
|
Eric Davis
|
r3325 | end | ||
|
Eric Davis
|
r3327 | |||
|
Eric Davis
|
r3339 | # 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 | ||||
|
Eric Davis
|
r3327 | # Check if a DN (user record) authenticates with the password | ||
| def authenticate_dn(dn, password) | ||||
|
Eric Davis
|
r3336 | if dn.present? && password.present? | ||
| initialize_ldap_con(dn, password).bind | ||||
| end | ||||
|
Eric Davis
|
r3327 | end | ||
|
Eric Davis
|
r3340 | |||
| # Get the user's dn and any attributes for them, given their login | ||||
|
Jean-Philippe Lang
|
r9121 | def get_user_dn(login, password) | ||
| ldap_con = nil | ||||
|
Jean-Philippe Lang
|
r9123 | if self.account && self.account.include?("$login") | ||
|
Jean-Philippe Lang
|
r9121 | ldap_con = initialize_ldap_con(self.account.sub("$login", Net::LDAP::DN.escape(login)), password) | ||
| else | ||||
| ldap_con = initialize_ldap_con(self.account, self.account_password) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r3378 | attrs = {} | ||
|
Jean-Philippe Lang
|
r10850 | search_filter = base_filter & Net::LDAP::Filter.eq(self.attr_login, login) | ||
|
Toshi MARUYAMA
|
r6392 | ldap_con.search( :base => self.base_dn, | ||
|
Jean-Philippe Lang
|
r8924 | :filter => search_filter, | ||
|
Eric Davis
|
r3340 | :attributes=> search_attributes) do |entry| | ||
| if onthefly_register? | ||||
| attrs = get_user_attributes_from_ldap_entry(entry) | ||||
| else | ||||
|
Jean-Philippe Lang
|
r3378 | attrs = {:dn => entry.dn} | ||
|
Eric Davis
|
r3340 | end | ||
|
Jean-Philippe Lang
|
r3378 | logger.debug "DN found for #{login}: #{attrs[:dn]}" if logger && logger.debug? | ||
|
Eric Davis
|
r3340 | end | ||
| attrs | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6392 | |||
|
Jean-Philippe Lang
|
r330 | def self.get_attr(entry, attr_name) | ||
|
Jean-Philippe Lang
|
r2054 | if !attr_name.blank? | ||
|
Jean-Philippe Lang
|
r14642 | value = entry[attr_name].is_a?(Array) ? entry[attr_name].first : entry[attr_name] | ||
|
Jean-Philippe Lang
|
r14643 | value.to_s.force_encoding('UTF-8') | ||
|
Jean-Philippe Lang
|
r2054 | end | ||
|
Jean-Philippe Lang
|
r10 | end | ||
| end | ||||