Class: Devise::LDAP::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/devise_ldap_norm/ldap/connection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Connection

Returns a new instance of Connection.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 6

def initialize(params = {})
  if ::Devise.ldap_config.is_a?(Proc)
    ldap_config = ::Devise.ldap_config.call
  else
    ldap_config = YAML.load(ERB.new(File.read(::Devise.ldap_config || "#{Rails.root}/config/ldap.yml")).result)[Rails.env]
  end
  ldap_options = params
  ldap_config['ssl'] = :simple_tls if ldap_config['ssl'] === true
  ldap_options[:encryption] = ldap_config['ssl'].to_sym if ldap_config['ssl']

  @ldap = Net::LDAP.new(ldap_options)
  @ldap.host = ldap_config['host']
  @ldap.port = ldap_config['port']
  @ldap.base = ldap_config['base']
  @attribute = ldap_config['attribute']
  @allow_unauthenticated_bind = ldap_config['allow_unauthenticated_bind']

  @ldap_auth_username_builder = params[:ldap_auth_username_builder]

  @group_base = ldap_config['group_base']
  @check_group_membership = ldap_config.has_key?('check_group_membership') ? ldap_config['check_group_membership'] : ::Devise.ldap_check_group_membership

  @allowed_groups = ldap_config['allowed_groups'] || []
  @allowed_groups = @allowed_groups.split(' ') if @allowed_groups.is_a? ::String

  @required_attributes = ldap_config["require_attribute"]

  @ldap.auth ldap_config["admin_user"], ldap_config["admin_password"] if params[:admin]
  @ldap.auth params[:login], params[:password] if ldap_config["admin_as_user"]

  @login = (params[:login] || '').gsub(/[^-\w.@]/i, '')
  @password = params[:password]
  @new_password = params[:new_password]
end

Instance Attribute Details

#ldap ⇒ Object (readonly)

Returns the value of attribute ldap.



4
5
6
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 4

def ldap
  @ldap
end

#login ⇒ Object (readonly)

Returns the value of attribute login.



4
5
6
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 4

def 
  @login
end

Instance Method Details

#authenticate! ⇒ Object 



79
80
81
82
83
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 79

def authenticate!
  return false unless (@password.present? || @allow_unauthenticated_bind)
  @ldap.auth(dn, @password)
  @ldap.bind
end

#authenticated? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 85

def authenticated?
  authenticate!
end

#authorized? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 89

def authorized?
  DeviseLdapNorm::Logger.send("Authorizing user #{dn}")
  if !authenticated?
    DeviseLdapNorm::Logger.send("Not authorized because not authenticated.")
    return false
  elsif !in_allowed_groups?
    DeviseLdapNorm::Logger.send("Not authorized because not in allowed groups.")
    return false
  elsif !has_required_attribute?
    DeviseLdapNorm::Logger.send("Not authorized because does not have required attribute.")
    return false
  else
    return true
  end
end

#change_password! ⇒ Object 



105
106
107
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 105

def change_password!
  update_ldap(:userpassword => Net::LDAP::Password.generate(:sha, @new_password))
end

#delete_param(param) ⇒ Object 



41
42
43
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 41

def delete_param(param)
  update_ldap [[:delete, param.to_sym, nil]]
end

#dn ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 49

def dn
  @dn ||= begin
    DeviseLdapNorm::Logger.send("LDAP dn lookup: #{@attribute}=#{@login}")
    ldap_entry = 
    if ldap_entry.nil?
      @ldap_auth_username_builder.call(@attribute,@login,@ldap)
    else
      ldap_entry.dn
    end
  end
end

#has_required_attribute? ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 172

def has_required_attribute?
  return true unless ::Devise.ldap_check_attributes

  admin_ldap = Connection.admin

  user = find_ldap_user(admin_ldap)

  @required_attributes.each do |key,val|
    unless user[key].include? val
      DeviseLdapNorm::Logger.send("User #{dn} did not match attribute #{key}:#{val}")
      return false
    end
  end

  return true
end

#in_allowed_groups? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 109

def in_allowed_groups?
  return true unless @check_group_membership

  memberships = self.ldap_param_value("memberOf")

  return false if memberships.blank?

  memberships.map! do |g|
    m = g.match(/cn=([A-Za-z0-9\._-]+),./)
    m[1] unless m.nil?
  end

  # array bisect to determine if any of the groups in groups is allowed access
  (memberships & @allowed_groups).length > 0
end

#in_group?(group_name, group_attribute = LDAP::DEFAULT_GROUP_UNIQUE_MEMBER_LIST_KEY) ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 142

def in_group?(group_name, group_attribute = LDAP::DEFAULT_GROUP_UNIQUE_MEMBER_LIST_KEY)
  in_group = false

  admin_ldap = Connection.admin

  unless ::Devise.ldap_ad_group_check
    admin_ldap.search(:base => group_name, :scope => Net::LDAP::SearchScope_BaseObject) do |entry|
      if entry[group_attribute].include? dn
        in_group = true
      end
    end
  else
    # AD optimization - extension will recursively check sub-groups with one query
    # "(memberof:1.2.840.113556.1.4.1941:=group_name)"
    search_result = admin_ldap.search(:base => dn,
                      :filter => Net::LDAP::Filter.ex("memberof:1.2.840.113556.1.4.1941", group_name),
                      :scope => Net::LDAP::SearchScope_BaseObject)
    # Will return  the user entry if belongs to group otherwise nothing
    if search_result.length == 1 && search_result[0].dn.eql?(dn)
      in_group = true
    end
  end

  unless in_group
    DeviseLdapNorm::Logger.send("User #{dn} is not in group: #{group_name}")
  end

  return in_group
end

#in_required_groups? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 125

def in_required_groups?
  return true unless @check_group_membership


  ## FIXME set errors here, the ldap.yml isn't set properly.
  return false if @required_groups.nil?

  for group in @required_groups
    if group.is_a?(Array)
      return false unless in_group?(group[1], group[0])
    else
      return false unless in_group?(group)
    end
  end
  return true
end

#ldap_param_value(param) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 61

def ldap_param_value(param)
  ldap_entry = 

  if ldap_entry
    unless ldap_entry[param].empty?
      value = ldap_entry.send(param)
      DeviseLdapNorm::Logger.send("Requested param #{param} has value #{value}")
      value
    else
      DeviseLdapNorm::Logger.send("Requested param #{param} does not exist")
      value = nil
    end
  else
    DeviseLdapNorm::Logger.send("Requested ldap entry does not exist")
    value = nil
  end
end

#search_for_login ⇒ Object

Searches the LDAP for the login

Returns:

  • (Object) —

    the LDAP entry found; nil if not found



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 204

def 
  @login_ldap_entry ||= begin
    DeviseLdapNorm::Logger.send("LDAP search for login: #{@attribute}=#{@login}")
    filter = Net::LDAP::Filter.eq(@attribute.to_s, @login.to_s)
    ldap_entry = nil
    match_count = 0
    @ldap.search(:filter => filter) {|entry| ldap_entry = entry; match_count+=1}
    DeviseLdapNorm::Logger.send("LDAP search yielded #{match_count} matches")
    ldap_entry
  end
end

#set_param(param, new_value) ⇒ Object 



45
46
47
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 45

def set_param(param, new_value)
  update_ldap( { param.to_sym => new_value } )
end

#user_groups ⇒ Object 



189
190
191
192
193
194
195
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 189

def user_groups
  admin_ldap = Connection.admin

  DeviseLdapNorm::Logger.send("Getting groups for #{dn}")
  filter = Net::LDAP::Filter.eq("uniqueMember", dn)
  admin_ldap.search(:filter => filter, :base => @group_base).collect(&:dn)
end

#valid_login? ⇒ Boolean

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/devise_ldap_norm/ldap/connection.rb', line 197

def valid_login?
  !.nil?
end