Class: ActiveLdap::Adapter::Base

7
8
9
10

# File 'lib/active_ldap/adapter/ldap.rb', line 7

def ldap_connection(options)
  require 'active_ldap/adapter/ldap_ext'
  Ldap.new(options)
end

9
10
11
12

# File 'lib/active_ldap/adapter/net_ldap.rb', line 9

def net_ldap_connection(options)
  require 'active_ldap/adapter/net_ldap_ext'
  NetLdap.new(options)
end

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# File 'lib/active_ldap/adapter/base.rb', line 77

def bind(options={})
  @bind_tried = true

  bind_dn = ensure_dn_string(options[:bind_dn] || @bind_dn)
  try_sasl = options.has_key?(:try_sasl) ? options[:try_sasl] : @try_sasl
  if options.has_key?(:allow_anonymous)
    allow_anonymous = options[:allow_anonymous]
  else
    allow_anonymous = @allow_anonymous
  end
  options = options.merge(:allow_anonymous => allow_anonymous)

  # Rough bind loop:
  # Attempt 1: SASL if available
  # Attempt 2: SIMPLE with credentials if password block
  # Attempt 3: SIMPLE ANONYMOUS if 1 and 2 fail (or pwblock returns '')
  if try_sasl and sasl_bind(bind_dn, options)
    @logger.info {_('Bound to %s by SASL as %s') % [target, bind_dn]}
  elsif simple_bind(bind_dn, options)
    @logger.info {_('Bound to %s by simple as %s') % [target, bind_dn]}
  elsif allow_anonymous and bind_as_anonymous(options)
    @logger.info {_('Bound to %s as anonymous') % target}
  else
    message = yield if block_given?
    message ||= _('All authentication methods for %s exhausted.') % target
    raise AuthenticationError, message
  end

  @bound = true
  @bound
end

114
115
116

# File 'lib/active_ldap/adapter/base.rb', line 114

def bind_as_anonymous(options={})
  yield
end

122
123
124

# File 'lib/active_ldap/adapter/base.rb', line 122

def bound?
  connecting? and @bound
end

53
54
55
56
57
58
59
60
61
62
63
64

# File 'lib/active_ldap/adapter/base.rb', line 53

def connect(options={})
  host = options[:host] || @host
  method = options[:method] || @method || :plain
  port = options[:port] || @port || ensure_port(method)
  method = ensure_method(method)
  @disconnected = false
  @bound = false
  @bind_tried = false
  @connection, @uri, @with_start_tls = yield(host, port, method)
  prepare_connection(options)
  bind(options)
end

118
119
120

# File 'lib/active_ldap/adapter/base.rb', line 118

def connecting?
  !@connection.nil? and !@disconnected
end

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

# File 'lib/active_ldap/adapter/base.rb', line 193

def delete(targets, options={})
  targets = [targets] unless targets.is_a?(Array)
  return if targets.empty?
  begin
    operation(options) do
      targets.each do |target|
        target = ensure_dn_string(target)
        begin
          yield(target)
        rescue LdapError::UnwillingToPerform, LdapError::InsufficientAccess
          raise OperationNotPermitted, _("%s: %s") % [$!.message, target]
        end
      end
    end
  rescue LdapError::NoSuchObject
    raise EntryNotFound, _("No such entry: %s") % target
  end
end

66
67
68
69
70

# File 'lib/active_ldap/adapter/base.rb', line 66

def disconnect!(options={})
  unbind(options)
  @connection = @uri = @with_start_tls = nil
  @disconnected = true
end

165
166
167
168

# File 'lib/active_ldap/adapter/base.rb', line 165

def entry_attribute(object_classes)
  @entry_attributes[object_classes.uniq.sort] ||=
    EntryAttribute.new(schema, object_classes)
end

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

# File 'lib/active_ldap/adapter/base.rb', line 233

def modify(dn, entries, options={})
  dn = ensure_dn_string(dn)
  begin
    operation(options) do
      begin
        yield(dn, entries)
      rescue LdapError::UnwillingToPerform, LdapError::InsufficientAccess
        raise OperationNotPermitted, _("%s: %s") % [$!.message, target]
      end
    end
  rescue LdapError::UndefinedType
    raise
  rescue LdapError::ObjectClassViolation
    raise RequiredAttributeMissed, _("%s: %s") % [$!.message, dn]
  end
end

250
251
252
253
254
255

# File 'lib/active_ldap/adapter/base.rb', line 250

def modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, options={})
  dn = ensure_dn_string(dn)
  operation(options) do
    yield(dn, new_rdn, delete_old_rdn, new_superior)
  end
end

156
157
158

# File 'lib/active_ldap/adapter/base.rb', line 156

def naming_contexts
  root_dse_values('namingContexts')
end

72
73
74
75

# File 'lib/active_ldap/adapter/base.rb', line 72

def rebind(options={})
  unbind(options) if bound?
  connect(options)
end

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

# File 'lib/active_ldap/adapter/base.rb', line 126

def schema(options={})
  @schema ||= operation(options) do
    base = options[:base]
    attrs = options[:attributes]

    attrs ||= [
      'objectClasses',
      'attributeTypes',
      'matchingRules',
      'matchingRuleUse',
      'dITStructureRules',
      'dITContentRules',
      'nameForms',
      'ldapSyntaxes',
      #'extendedAttributeInfo', # if we need RANGE-LOWER/UPPER.
    ]
    base ||= root_dse_values('subschemaSubentry', options)[0]
    base ||= 'cn=schema'
    schema = nil
    search(:base => base,
           :scope => :base,
           :filter => '(objectClass=subschema)',
           :attributes => attrs,
           :limit => 1) do |dn, attributes|
      schema = Schema.new(attributes)
    end
    schema || Schema.new([])
  end
end

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

# File 'lib/active_ldap/adapter/base.rb', line 170

def search(options={})
  filter = parse_filter(options[:filter]) || 'objectClass=*'
  attrs = options[:attributes] || []
  scope = ensure_scope(options[:scope] || @scope)
  base = options[:base]
  limit = options[:limit] || 0
  limit = nil if limit <= 0

  attrs = attrs.to_a # just in case
  base = ensure_dn_string(base)
  begin
    operation(options) do
      yield(base, scope, filter, attrs, limit)
    end
  rescue LdapError::NoSuchObject, LdapError::InvalidDnSyntax
    # Do nothing on failure
    @logger.info do
      args = [$!.class, $!.message, filter, attrs.inspect]
      _("Ignore error %s(%s): filter %s: attributes: %s") % args
    end
  end
end

160
161
162
163

# File 'lib/active_ldap/adapter/base.rb', line 160

def supported_control
  @supported_control ||=
    SupportedControl.new(root_dse_values("supportedControl"))
end

109
110
111
112

# File 'lib/active_ldap/adapter/base.rb', line 109

def unbind(options={})
  yield if @connection and (@bind_tried or bound?)
  @bind_tried = @bound = false
end