Alias dereferencing should be supported

[halostatue]

Originally submitted by Jonathan Clarke (jooooooon) on 2009-07-02:

The "deref" parameter to the search command is ignored, unlike in the original Net::LDAP. This supports dereferencing aliases during search, either in search results or when locating the base object for the search.

The attached patch adds support to this, in the same style as the scope parameter. Possible values are: Net::LDAP::DerefAliases_Never, Net::LDAP::DerefAliases_Search, Net::LDAP::DerefAliases_Find, Net::LDAP::DerefAliases_Always. Default is Never.

Please consider it for inclusion it Ruby Net::LDAP. Thanks.

[halostatue]

Comment by Austin Ziegler on 2010-09-25 (edited for URL update):

I am interested in using this patch, but if you could check it against the latest source (github.com/ruby-ldap/ruby-net-ldap) and provide some tests to know that we're doing the right thing, that would be appreciated.

[halostatue]

diff -Naur ../../lsc-redmine/redmine/vendor/plugins/ruby-net-ldap-0.0.4/lib/net/ldap.rb vendor/plugins/ruby-net-ldap-0.0.4/lib/net/ldap.rb
--- ../../lsc-redmine/redmine/vendor/plugins/ruby-net-ldap-0.0.4/lib/net/ldap.rb    2009-05-17 11:09:35.000000000 +0200
+++ vendor/plugins/ruby-net-ldap-0.0.4/lib/net/ldap.rb  2009-07-01 10:58:29.000000000 +0200
@@ -271,6 +271,12 @@
     SearchScope_WholeSubtree = 2
     SearchScopes = [SearchScope_BaseObject, SearchScope_SingleLevel, SearchScope_WholeSubtree]

+    DerefAliases_Never = 0
+    DerefAliases_Search = 1
+    DerefAliases_Find = 2
+    DerefAliases_Always = 3
+    DerefAliasesArray = [DerefAliases_Never, DerefAliases_Search, DerefAliases_Find, DerefAliases_Always]
+
     AsnSyntax = {
       :application => {
         :constructed => {
@@ -555,6 +561,7 @@
     # * :return_result (a boolean specifying whether to return a result set).
     # * :attributes_only (a boolean flag, defaults false)
     # * :scope (one of: Net::LDAP::SearchScope_BaseObject, Net::LDAP::SearchScope_SingleLevel, Net::LDAP::SearchScope_WholeSubtree. Default is WholeSubtree.)
+    # * :deref (one of: Net::LDAP::DerefAliases_Never, Net::LDAP::DerefAliases_Search, Net::LDAP::DerefAliases_Find, Net::LDAP::DerefAliases_Always. Default is Never.)
     #
     # #search queries the LDAP server and passes <i>each entry</i> to the
     # caller-supplied block, as an object of type Net::LDAP::Entry.
@@ -1134,6 +1141,9 @@
       scope = args[:scope] || Net::LDAP::SearchScope_WholeSubtree
       raise LdapError.new( "invalid search scope" ) unless SearchScopes.include?(scope)

+      deref = args[:deref] || Net::LDAP::DerefAliases_Never
+      raise LdapError.new( "invalid alias dereferencing value" ) unless DerefAliasesArray.include?(deref)
+
       # An interesting value for the size limit would be close to A/D's built-in
       # page limit of 1000 records, but openLDAP newer than version 2.2.0 chokes
       # on anything bigger than 126. You get a silent error that is easily visible
@@ -1147,7 +1157,7 @@
         request = [
           search_base.to_ber,
           scope.to_ber_enumerated,
-          0.to_ber_enumerated,
+          deref.to_ber_enumerated,
           0.to_ber,
           0.to_ber,
           attributes_only.to_ber,

[halostatue]

Comment on 2011-07-12 by Paul McCann:

Is this going to be considered for the next release. I am also very interested in this as I need to set deref to derefAlways

[ismisepaul]

I have a couple of questions;

1. Can this patch be applied to 0.2.2 and how is this done?
2. Is there another way I can set 'deref' to derefAlways (Another library or some way of hacking the existing code)

Here's some sample code on what I'm trying to do (it's pretty much like the example code)

require 'net/ldap'

treebase = "ou=companyweb,o=company.com"

ldap = Net::LDAP.new :host => '192.168.0.11',
:port => 389,
:base => treebase

filter = Net::LDAP::Filter.eq("objectclass", "companyPerson") &
Net::LDAP::Filter.eq("mail", "myname@email.com")

ldap.search(:base => treebase, :filter => filter)do |entry|
puts "DN: #{entry.dn}"
entry.each do |attribute, values|
puts " #{attribute}:"
values.each do |value|
puts " --->#{value}"
end
end
end

p ldap.get_operation_result

Thanks

[halostatue]

I don't know whether the diff will work; it is against an earlier verison (0.0.4?) and I posted a request on the other tracking system (now closed) to have the original submitter try it against Rory's (then-current) repository. I pasted in here to capture the diff so that someone would try to apply it against the current repository.

[jch]

Closed by #49