Class: ActiveLdap::Adapter::Base

Inherits:
Object
  • Object
show all
Includes:
GetTextSupport
Defined in:
lib/active_ldap/adapter/base.rb,
lib/active_ldap/adapter/jndi.rb,
lib/active_ldap/adapter/ldap.rb,
lib/active_ldap/adapter/net_ldap.rb

Direct Known Subclasses

Jndi, Ldap, NetLdap

Constant Summary collapse

VALID_ADAPTER_CONFIGURATION_KEYS = 
[:host, :port, :method, :timeout,
:retry_on_timeout, :retry_limit,
:retry_wait, :bind_dn, :password,
:password_block, :try_sasl,
:sasl_mechanisms, :sasl_quiet,
:allow_anonymous, :store_password,
:scope]
@@row_even = 
true

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GetTextSupport

included

Constructor Details

#initialize(configuration = {}) ⇒ Base

Returns a new instance of Base.



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/active_ldap/adapter/base.rb', line 23

def initialize(configuration={})
  @runtime = 0
  @connection = nil
  @disconnected = false
  @entry_attributes = {}
  @configuration = configuration.dup
  @logger = @configuration.delete(:logger)
  @configuration.assert_valid_keys(VALID_ADAPTER_CONFIGURATION_KEYS)
  VALID_ADAPTER_CONFIGURATION_KEYS.each do |name|
    instance_variable_set("@#{name}", configuration[name])
  end
end

Instance Attribute Details

#runtime ⇒ Object (readonly)

Returns the value of attribute runtime.



22
23
24
 
# File 'lib/active_ldap/adapter/base.rb', line 22

def runtime
  @runtime
end

Class Method Details

.jndi_connection(options) ⇒ Object 



7
8
9
10
 
# File 'lib/active_ldap/adapter/jndi.rb', line 7

def jndi_connection(options)
  require 'active_ldap/adapter/jndi_connection'
  Jndi.new(options)
end

.ldap_connection(options) ⇒ Object 



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

.net_ldap_connection(options) ⇒ Object 



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

Instance Method Details

#add(dn, entries, options = {}) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/active_ldap/adapter/base.rb', line 178

def add(dn, entries, options={})
  begin
    operation(options) do
      yield(dn, entries)
    end
  rescue LdapError::NoSuchObject
    raise EntryNotFound, _("No such entry: %s") % dn
  rescue LdapError::InvalidDnSyntax
    raise DistinguishedNameInvalid.new(dn)
  rescue LdapError::AlreadyExists
    raise EntryAlreadyExist, _("%s: %s") % [$!.message, dn]
  rescue LdapError::StrongAuthRequired
    raise StrongAuthenticationRequired, _("%s: %s") % [$!.message, dn]
  rescue LdapError::ObjectClassViolation
    raise RequiredAttributeMissed, _("%s: %s") % [$!.message, dn]
  rescue LdapError::UnwillingToPerform
    raise OperationNotPermitted, _("%s: %s") % [$!.message, dn]
  end
end

#bind(options = {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/active_ldap/adapter/base.rb', line 62

def bind(options={})
  bind_dn = 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?
end

#bind_as_anonymous(options = {}) ⇒ Object 



91
92
93
94
95
 
# File 'lib/active_ldap/adapter/base.rb', line 91

def bind_as_anonymous(options={})
  operation(options) do
    yield
  end
end

#connect(options = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'lib/active_ldap/adapter/base.rb', line 41

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

#connecting? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/active_ldap/adapter/base.rb', line 97

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

#delete(targets, options = {}) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/active_ldap/adapter/base.rb', line 163

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

#disconnect!(options = {}) ⇒ Object 



51
52
53
54
55
 
# File 'lib/active_ldap/adapter/base.rb', line 51

def disconnect!(options={})
  return if @connection.nil?
  unbind(options)
  @connection = @uri = @with_start_tls = nil
end

#entry_attribute(object_classes) ⇒ Object 



127
128
129
130
 
# File 'lib/active_ldap/adapter/base.rb', line 127

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

#log_info(name, runtime, info = nil) ⇒ Object 



216
217
218
219
220
221
 
# File 'lib/active_ldap/adapter/base.rb', line 216

def log_info(name, runtime, info=nil)
  return unless @logger
  return unless @logger.debug?
  message = "LDAP: #{name} (#{'%f' % runtime})"
  @logger.debug(format_log_entry(message, info))
end

#modify(dn, entries, options = {}) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/active_ldap/adapter/base.rb', line 198

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

#modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, options = {}) ⇒ Object 



210
211
212
213
214
 
# File 'lib/active_ldap/adapter/base.rb', line 210

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

#rebind(options = {}) ⇒ Object 



57
58
59
60
 
# File 'lib/active_ldap/adapter/base.rb', line 57

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

#reset_runtime ⇒ Object 



36
37
38
39
 
# File 'lib/active_ldap/adapter/base.rb', line 36

def reset_runtime
  runtime, @runtime = @runtime, 0
  runtime
end

#schema(options = {}) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/active_ldap/adapter/base.rb', line 101

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'
    dn, attributes = search(:base => base,
                            :scope => :base,
                            :filter => '(objectClass=subschema)',
                            :attributes => attrs).first
    Schema.new(attributes)
  end
end

#search(options = {}) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_ldap/adapter/base.rb', line 132

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

  values = []
  callback = Proc.new do |value, block|
    value = block.call(value) if block
    values << value
  end

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

  values
end