Class: ActiveLdap::Adapter::Base
- Inherits:
-
Object
- Object
- ActiveLdap::Adapter::Base
- 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
Constant Summary collapse
- VALID_ADAPTER_CONFIGURATION_KEYS =
[ :host, :port, :method, :tls_options, :timeout, :retry_on_timeout, :retry_limit, :retry_wait, :bind_dn, :password, :password_block, :try_sasl, :sasl_mechanisms, :sasl_quiet, :allow_anonymous, :store_password, :scope, :sasl_options, :follow_referrals, ]
- @@row_even =
true
Class Method Summary collapse
- .jndi_connection(options) ⇒ Object
- .ldap_connection(options) ⇒ Object
- .net_ldap_connection(options) ⇒ Object
Instance Method Summary collapse
- #add(dn, entries, options = {}) ⇒ Object
- #bind(options = {}) ⇒ Object
- #bind_as_anonymous(options = {}) ⇒ Object
- #bound? ⇒ Boolean
- #connect(options = {}) ⇒ Object
- #connecting? ⇒ Boolean
- #delete(targets, options = {}) ⇒ Object
- #disconnect!(options = {}) ⇒ Object
- #entry_attribute(object_classes) ⇒ Object
-
#initialize(configuration = {}) ⇒ Base
constructor
A new instance of Base.
- #modify(dn, entries, options = {}) ⇒ Object
- #modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, options = {}) ⇒ Object
- #naming_contexts ⇒ Object
- #rebind(options = {}) ⇒ Object
- #schema(options = {}) ⇒ Object
- #search(options = {}) ⇒ Object
- #supported_control ⇒ Object
- #unbind(options = {}) ⇒ Object
Methods included from GetTextSupport
Constructor Details
#initialize(configuration = {}) ⇒ Base
Returns a new instance of Base.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/active_ldap/adapter/base.rb', line 37 def initialize(configuration={}) @connection = nil @disconnected = false @bound = false @bind_tried = false @entry_attributes = {} @follow_referrals = nil @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 @follow_referrals = true if @follow_referrals.nil? @instrumenter = ActiveSupport::Notifications.instrumenter end |
Class Method Details
.jndi_connection(options) ⇒ Object
7 8 9 10 |
# File 'lib/active_ldap/adapter/jndi.rb', line 7 def jndi_connection() require 'active_ldap/adapter/jndi_connection' Jndi.new() end |
Instance Method Details
#add(dn, entries, options = {}) ⇒ Object
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/active_ldap/adapter/base.rb', line 213 def add(dn, entries, ={}) dn = ensure_dn_string(dn) begin operation() 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") % [$!., dn] rescue LdapError::StrongAuthRequired raise StrongAuthenticationRequired, _("%s: %s") % [$!., dn] rescue LdapError::ObjectClassViolation raise RequiredAttributeMissed, _("%s: %s") % [$!., dn] rescue LdapError::UnwillingToPerform raise OperationNotPermitted, _("%s: %s") % [$!., dn] end end |
#bind(options = {}) ⇒ Object
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 108 |
# File 'lib/active_ldap/adapter/base.rb', line 78 def bind(={}) @bind_tried = true bind_dn = ensure_dn_string([:bind_dn] || @bind_dn) try_sasl = .has_key?(:try_sasl) ? [:try_sasl] : @try_sasl if .has_key?(:allow_anonymous) allow_anonymous = [:allow_anonymous] else allow_anonymous = @allow_anonymous end = .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, ) @logger.info {_('Bound to %s by SASL as %s') % [target, bind_dn]} elsif simple_bind(bind_dn, ) @logger.info {_('Bound to %s by simple as %s') % [target, bind_dn]} elsif allow_anonymous and bind_as_anonymous() @logger.info {_('Bound to %s as anonymous') % target} else = yield if block_given? ||= _('All authentication methods for %s exhausted.') % target raise AuthenticationError, end @bound = true @bound end |
#bind_as_anonymous(options = {}) ⇒ Object
115 116 117 |
# File 'lib/active_ldap/adapter/base.rb', line 115 def bind_as_anonymous(={}) yield end |
#bound? ⇒ Boolean
123 124 125 |
# File 'lib/active_ldap/adapter/base.rb', line 123 def bound? connecting? and @bound end |
#connect(options = {}) ⇒ Object
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/active_ldap/adapter/base.rb', line 54 def connect(={}) host = [:host] || @host method = [:method] || @method || :plain port = [: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() bind() end |
#connecting? ⇒ Boolean
119 120 121 |
# File 'lib/active_ldap/adapter/base.rb', line 119 def connecting? !@connection.nil? and !@disconnected end |
#delete(targets, options = {}) ⇒ Object
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/active_ldap/adapter/base.rb', line 194 def delete(targets, ={}) targets = [targets] unless targets.is_a?(Array) return if targets.empty? begin operation() do targets.each do |target| target = ensure_dn_string(target) begin yield(target) rescue LdapError::UnwillingToPerform, LdapError::InsufficientAccess raise OperationNotPermitted, _("%s: %s") % [$!., target] end end end rescue LdapError::NoSuchObject raise EntryNotFound, _("No such entry: %s") % target end end |
#disconnect!(options = {}) ⇒ Object
67 68 69 70 71 |
# File 'lib/active_ldap/adapter/base.rb', line 67 def disconnect!(={}) unbind() @connection = @uri = @with_start_tls = nil @disconnected = true end |
#entry_attribute(object_classes) ⇒ Object
166 167 168 169 |
# File 'lib/active_ldap/adapter/base.rb', line 166 def entry_attribute(object_classes) @entry_attributes[object_classes.uniq.sort] ||= EntryAttribute.new(schema, object_classes) end |
#modify(dn, entries, options = {}) ⇒ Object
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/active_ldap/adapter/base.rb', line 234 def modify(dn, entries, ={}) dn = ensure_dn_string(dn) begin operation() do begin yield(dn, entries) rescue LdapError::UnwillingToPerform, LdapError::InsufficientAccess raise OperationNotPermitted, _("%s: %s") % [$!., target] end end rescue LdapError::UndefinedType raise rescue LdapError::ObjectClassViolation raise RequiredAttributeMissed, _("%s: %s") % [$!., dn] end end |
#modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, options = {}) ⇒ Object
251 252 253 254 255 256 |
# File 'lib/active_ldap/adapter/base.rb', line 251 def modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, ={}) dn = ensure_dn_string(dn) operation() do yield(dn, new_rdn, delete_old_rdn, new_superior) end end |
#naming_contexts ⇒ Object
157 158 159 |
# File 'lib/active_ldap/adapter/base.rb', line 157 def naming_contexts root_dse_values('namingContexts') end |
#rebind(options = {}) ⇒ Object
73 74 75 76 |
# File 'lib/active_ldap/adapter/base.rb', line 73 def rebind(={}) unbind() if bound? connect() end |
#schema(options = {}) ⇒ Object
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 155 |
# File 'lib/active_ldap/adapter/base.rb', line 127 def schema(={}) @schema ||= operation() do base = [:base] attrs = [:attributes] attrs ||= [ 'objectClasses', 'attributeTypes', 'matchingRules', 'matchingRuleUse', 'dITStructureRules', 'dITContentRules', 'nameForms', 'ldapSyntaxes', #'extendedAttributeInfo', # if we need RANGE-LOWER/UPPER. ] base ||= root_dse_values('subschemaSubentry', )[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 |
#search(options = {}) ⇒ Object
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/active_ldap/adapter/base.rb', line 171 def search(={}) filter = parse_filter([:filter]) || 'objectClass=*' attrs = [:attributes] || [] scope = ensure_scope([:scope] || @scope) base = [:base] limit = [:limit] || 0 limit = nil if limit <= 0 attrs = attrs.to_a # just in case base = ensure_dn_string(base) begin operation() do yield(base, scope, filter, attrs, limit) end rescue LdapError::NoSuchObject, LdapError::InvalidDnSyntax # Do nothing on failure @logger.info do args = [$!.class, $!., filter, attrs.inspect] _("Ignore error %s(%s): filter %s: attributes: %s") % args end end end |
#supported_control ⇒ Object
161 162 163 164 |
# File 'lib/active_ldap/adapter/base.rb', line 161 def supported_control @supported_control ||= SupportedControl.new(root_dse_values("supportedControl")) end |
#unbind(options = {}) ⇒ Object
110 111 112 113 |
# File 'lib/active_ldap/adapter/base.rb', line 110 def unbind(={}) yield if @connection and (@bind_tried or bound?) @bind_tried = @bound = false end |