activeldap 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e102a4e1e1913dcbc4ba91e6efdcf1c810273ab0df7843dda96e7a25448115e
-  data.tar.gz: 641ed3e13f779e61a8ca2bb7b7451a2a262e6118cf3ebae09e05bca731ed3531
+  metadata.gz: 671ebd65e9137cf2ec38a775a132613c5449488b3b4a3aa9e41a75cf139409ed
+  data.tar.gz: 7f85f67f45bb076a68708ba5254f1594762f5d064218354e9e28e8a23e0e36b8
 SHA512:
-  metadata.gz: 8cdb1be2238d42a244c1e4bfd1d02741b3944f16bbfdd4b787fa07d7b16fb9c054f91316b540eec1e27660a16fe84a6fed30cdbb103d04bab565f4f1ed366026
-  data.tar.gz: bd5abb24368bc0e966398d8352b323f665ee6c9ff7ccb3d7cbaea556b87c0c9885458dcaba804176ba8992ad513e812a4e3a357c380fa14801e2b7838cbbc790
+  metadata.gz: 5896d1b97e081ec36d8ca8839391dea136ecf5a6cf49c71cf712095919364e6a6928405e4b63ed8bd96b36a9e2720604447713ccb610471b229b191d70a4f32a
+  data.tar.gz: 1d0c88a095252b8adec8df38aa4192ece39ef39ddbf741e38927685a4dd603b62f0d30a0d4c30137bc7a8f66c3b296cfb8214b7343a839949a0c51b04abd3247

data/doc/text/news.md

@@ -1,5 +1,24 @@
 # News
 
+## 6.0.3: 2020-08-17 {#release-6-0-3}
+
+### Improvements
+
+  * Added support for `save(validate: false)`.
+    [GitHub#180][Reported by Kevin McCormack]
+
+  * jndi: Added support for follow referrals.
+    [GitHub#182][Patch by Kevin McCormack]
+
+### Fixes
+
+  * Fixed a bug that sub base is ignored in DN specified by `new`.
+    [GitHub#185][Reported by Kevin McCormack]
+
+### Thanks
+
+  * Kevin McCormack
+
 ## 6.0.2: 2020-05-19 {#release-6-0-2}
 
 ### Improvements

data/lib/active_ldap/adapter/jndi.rb

@@ -22,9 +22,23 @@ module ActiveLdap
         super do |host, port, method|
           uri = construct_uri(host, port, method == :ssl)
           with_start_tls = method == :start_tls
-          info = {:uri => uri, :with_start_tls => with_start_tls}
-          [log("connect", info) {JndiConnection.new(host, port, method, @timeout)},
-           uri, with_start_tls]
+          follow_referrals = follow_referrals?(options)
+          info = {
+            :uri => uri,
+            :with_start_tls => with_start_tls,
+            :follow_referrals => follow_referrals,
+          }
+          [
+            log("connect", info) {
+              JndiConnection.new(host,
+                                 port,
+                                 method,
+                                 @timeout,
+                                 follow_referrals)
+            },
+            uri,
+            with_start_tls,
+          ]
         end
       end
 

data/lib/active_ldap/adapter/jndi_connection.rb

@@ -75,13 +75,14 @@ module ActiveLdap
         end
       end
 
-      def initialize(host, port, method, timeout)
+      def initialize(host, port, method, timeout, follow_referrals)
         @host = host
         @port = port
         @method = method
         @timeout = timeout
         @context = nil
         @tls = nil
+        @follow_referrals = follow_referrals
       end
 
       def unbind
@@ -203,9 +204,10 @@ module ActiveLdap
           Context::PROVIDER_URL => ldap_uri,
           'com.sun.jndi.ldap.connect.timeout' => (@timeout * 1000).to_i.to_s,
           'com.sun.jndi.ldap.read.timeout' => (@timeout * 1000).to_i.to_s,
+          'java.naming.ldap.derefAliases' => 'never',
+          'java.naming.referral' => @follow_referrals ? 'follow' : 'ignore',
         }
-        environment = HashTable.new(environment)
-        context = InitialLdapContext.new(environment, nil)
+        context = InitialLdapContext.new(HashTable.new(environment), nil)
         if @method == :start_tls
           @tls = context.extended_operation(StartTlsRequest.new)
           @tls.negotiate

data/lib/active_ldap/adapter/ldap.rb

@@ -209,15 +209,17 @@ module ActiveLdap
       def prepare_connection(options={})
         operation(options) do
           @connection.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
-          unless follow_referrals?(options)
-            @connection.set_option(LDAP::LDAP_OPT_REFERRALS, 0)
-          end
+          @ldap_follow_referrals = follow_referrals?(options) ? 1 : 0
+          @connection.set_option(LDAP::LDAP_OPT_REFERRALS,
+                                 @ldap_follow_referrals)
         end
       end
 
       def execute(method, info=nil, *args, &block)
         begin
           name = (info || {}).delete(:name) || method
+          @connection.set_option(LDAP::LDAP_OPT_REFERRALS,
+                                 @ldap_follow_referrals)
           log(name, info) {@connection.send(method, *args, &block)}
         rescue LDAP::ResultError
           @connection.assert_error_code

data/lib/active_ldap/base.rb

@@ -851,6 +851,8 @@ module ActiveLdap
 
       _schema = _local_entry_attribute = nil
       targets = sanitize_for_mass_assignment(new_attributes)
+      have_dn = false
+      dn_value = nil
       targets.each do |key, value|
         setter = "#{key}="
         unless respond_to?(setter)
@@ -860,8 +862,15 @@ module ActiveLdap
           _local_entry_attribute ||= local_entry_attribute
           _local_entry_attribute.register(attribute)
         end
-        send(setter, value)
+        case setter
+        when "dn=", "id="
+          have_dn = true
+          dn_value = value
+        else
+          send(setter, value)
+        end
       end
+      self.dn = dn_value if have_dn
     end
 
     def to_ldif_record
@@ -1281,6 +1290,7 @@ module ActiveLdap
     end
 
     def compute_base
+      ensure_update_dn
       base_of_class = self.class.base
       if @base_value.nil?
         base_of_class

data/lib/active_ldap/validations.rb

@@ -53,15 +53,23 @@ module ActiveLdap
       errors.empty? && output
     end
 
-    def save(*)
-      valid? ? super : false
+    def save(**options)
+      perform_validations(options) ? super : false
     end
 
-    def save!(*)
-      valid? ? super : raise(EntryInvalid.new(self))
+    def save!(**options)
+      perform_validations(options) ? super : raise(EntryInvalid.new(self))
     end
 
     private
+    def perform_validations(options)
+      if options[:validate] == false
+        true
+      else
+        valid?(options[:context])
+      end
+    end
+
     def format_validation_message(format, parameters)
       format % parameters
     end

data/lib/active_ldap/version.rb

@@ -1,3 +1,3 @@
 module ActiveLdap
-  VERSION = "6.0.2"
+  VERSION = "6.0.3"
 end

data/test/add-phonetic-attribute-options-to-slapd.ldif

@@ -1,6 +1,6 @@
 # Your LDAP server needs to accept 'phonetic' attribute option for test.
 # This is a LDIF file for OpenLDAP to do the configuration.
-# You can use this file by the following command linne on Debian GNU/Linux
+# You can use this file by the following command line on Debian GNU/Linux
 # or Ubuntu:
 #   % sudo -H ldapmodify -Y EXTERNAL -H ldapi:/// -f test/add-phonetic-attribute-options-to-slapd.ldif
 version: 1

data/test/al-test-utils.rb

@@ -182,6 +182,7 @@ module AlTestUtils
       populate_ou
       populate_user_class
       populate_group_class
+      populate_group_of_urls_class
       populate_associations
     end
 
@@ -215,7 +216,7 @@ module AlTestUtils
     end
 
     def populate_ou
-      %w(Users Groups).each do |name|
+      %w(Users Groups GroupOfURLsSet).each do |name|
         make_ou(name)
       end
     end
@@ -246,6 +247,14 @@ module AlTestUtils
       assign_class_name(@group_class, "Group")
     end
 
+    def populate_group_of_urls_class
+      @group_of_urls_class = Class.new(ActiveLdap::Base)
+      @group_of_urls_class.ldap_mapping :prefix => "ou=GroupOfURLsSet",
+                                        :scope => :sub,
+                                        :classes => ["groupOfURLs"]
+      assign_class_name(@group_of_urls_class, "GroupOfURLs")
+    end
+
     def populate_associations
       @user_class.belongs_to :groups, :many => "memberUid"
       @user_class.belongs_to :primary_group,
@@ -280,6 +289,7 @@ module AlTestUtils
       super
       @user_index = 0
       @group_index = 0
+      @group_of_urls_index = 0
       @temporary_uids = []
     end
 
@@ -366,6 +376,25 @@ module AlTestUtils
       end
     end
 
+    def make_temporary_group_of_urls(config={})
+      @group_of_urls_index += 1
+      cn = config[:cn] || "temp-group-of-urls-#{@group_of_urls_index}"
+      ensure_delete_group_of_urls(cn) do
+        _wrap_assertion do
+          assert(!@group_of_urls_class.exists?(cn))
+          assert_raise(ActiveLdap::EntryNotFound) do
+            @group_of_urls_class.find(cn)
+          end
+          group_of_urls = @group_of_urls_class.new(cn)
+          assert(group_of_urls.new_entry?)
+          group_of_urls.member_url = config[:member_url]
+          assert(group_of_urls.save!)
+          assert(!group_of_urls.new_entry?)
+          yield(@group_of_urls_class.find(group_of_urls.cn))
+        end
+      end
+    end
+
     def ensure_delete_user(uid)
       yield(uid)
     ensure
@@ -379,6 +408,12 @@ module AlTestUtils
       @group_class.delete(cn) if @group_class.exists?(cn)
     end
 
+    def ensure_delete_group_of_urls(cn)
+      yield(cn)
+    ensure
+      @group_of_urls_class.delete(cn) if @group_of_urls_class.exists?(cn)
+    end
+
     def default_uid
       "10000#{@user_index}"
     end
@@ -467,6 +502,11 @@ module AlTestUtils
       omit(message || "This test is not for JRuby")
     end
 
+    def omit_unless_jruby(message=nil)
+      return if RUBY_PLATFORM == "java"
+      omit(message || "This test is only for JRuby")
+    end
+
     def omit_if_ldap(message=nil)
       return if current_configuration[:adapter] == "ldap"
       omit(message || "This test is not for ruby-ldap")

data/test/enable-dynamic-groups.ldif

@@ -0,0 +1,22 @@
+# Your LDAP server needs to support dynamic list for test.
+# This is a LDIF file for OpenLDAP to do the configuration.
+# You can use this file by the following command line on Debian GNU/Linux
+# or Ubuntu:
+#
+#   % sudo -H ldapadd -Y EXTERNAL -H ldapi:/// -f /etc/ldap/schema/dyngroup.ldif
+#   % sudo -H ldapmodify -Y EXTERNAL -H ldapi:/// -f test/enable-dynamic-groups.ldif
+version: 1
+
+# Enable dynlist module
+dn: cn=module{0},cn=config
+changetype: modify
+add: olcModuleLoad
+olcModuleLoad: dynlist
+
+# Set up dynlist overlay
+dn: olcOverlay=dynlist,olcDatabase={1}mdb,cn=config
+changetype: add
+objectClass: olcOverlayConfig
+objectClass: olcDynamicList
+olcOverlay: dynlist
+olcDlAttrSet: groupOfURLs memberURL member

data/test/enable-start-tls.ldif

@@ -1,6 +1,6 @@
 # Your LDAP server needs to support StartTLS when you test StartTLS related
 # feature. This is a LDIF file for OpenLDAP to do the configuration.
-# You can use this file by the following command linne on Debian GNU/Linux
+# You can use this file by the following command line on Debian GNU/Linux
 # or Ubuntu:
 #
 #   % sudo usermod -a -G ssl-cert openldap

data/test/test_base.rb

@@ -5,7 +5,52 @@ require 'al-test-utils'
 class TestBase < Test::Unit::TestCase
   include AlTestUtils
 
+  sub_test_case("follow_referrals") do
+    def test_default
+      make_temporary_user do |user1,|
+        make_temporary_user do |user2,|
+          member_url = ["ldap:///#{user1.base.to_s}??one?(objectClass=person)"]
+          make_temporary_group_of_urls(member_url: member_url) do |group_of_urls|
+            assert_equal([user1.dn, user2.dn],
+                         group_of_urls.attributes["member"])
+          end
+        end
+      end
+    end
+
+    def test_connection_false
+      omit_unless_jruby
+      @group_of_urls_class.setup_connection(
+        current_configuration.merge(follow_referrals: false)
+      )
+      make_temporary_user do |user1,|
+        make_temporary_user do |user2,|
+          member_url = ["ldap:///#{user1.base.to_s}??one?(objectClass=person)"]
+          make_temporary_group_of_urls(member_url: member_url) do |group_of_urls|
+            assert_nil(group_of_urls.attributes["member"])
+          end
+        end
+      end
+    end
+
+    def test_connect_false
+      omit_unless_jruby
+      connection = @group_of_urls_class.connection
+      connection.disconnect!
+      connection.connect(follow_referrals: false)
+      make_temporary_user do |user1,|
+        make_temporary_user do |user2,|
+          member_url = ["ldap:///#{user1.base.to_s}??one?(objectClass=person)"]
+          make_temporary_group_of_urls(member_url: member_url) do |group_of_urls|
+            assert_nil(group_of_urls.attributes["member"])
+          end
+        end
+      end
+    end
+  end
+
   priority :must
+  priority :normal
   def test_search_colon_value
     make_temporary_group(:cn => "temp:group") do |group|
       assert_equal("temp:group", group.cn)
@@ -13,7 +58,6 @@ class TestBase < Test::Unit::TestCase
     end
   end
 
-  priority :normal
   def test_lower_case_object_class
     fixture_file = fixture("lower_case_object_class_schema.rb")
     schema_entries = eval(File.read(fixture_file))
@@ -122,9 +166,9 @@ class TestBase < Test::Unit::TestCase
 
   def test_operational_attributes
     make_temporary_group do |group|
-      dn, attributes = @group_class.search(:attributes => ["*"])[0]
+      _dn, attributes = @group_class.search(:attributes => ["*"])[0]
       normal_attributes = attributes.keys
-      dn, attributes = @group_class.search(:attributes => ["*", "+"])[0]
+      _dn, attributes = @group_class.search(:attributes => ["*", "+"])[0]
       operational_attributes = attributes.keys - normal_attributes
       operational_attribute = operational_attributes[0]
 
@@ -383,7 +427,7 @@ class TestBase < Test::Unit::TestCase
     end
   end
 
-  def test_set_dn_with_unnormalized_dn_attribute_with_forward_slash 
+  def test_set_dn_with_unnormalized_dn_attribute_with_forward_slash
     make_temporary_user do |user,|
       new_dn = "uid=temp/user1,#{user.class.base}"
       assert_not_equal(user.dn.to_s, new_dn)
@@ -394,7 +438,7 @@ class TestBase < Test::Unit::TestCase
       assert_true(user.save!)
       assert_true(user.class.find(user.uid).update_attributes!(gidNumber: 100069))
     end
- end
+  end
 
   def test_destroy_with_empty_base_and_prefix_of_class
     make_temporary_user do |user,|
@@ -958,7 +1002,8 @@ class TestBase < Test::Unit::TestCase
     ou_class.ldap_mapping(:dn_attribute => :ou,
                           :prefix => "",
                           :classes => ["top", "organizationalUnit"])
-    assert_equal(["ou=Groups,#{current_configuration['base']}",
+    assert_equal(["ou=GroupOfURLsSet,#{current_configuration['base']}",
+                  "ou=Groups,#{current_configuration['base']}",
                   "ou=Users,#{current_configuration['base']}"],
                  ou_class.find(:all).collect(&:dn).collect(&:to_s).sort)
   end

data/test/test_base_per_instance.rb

@@ -9,13 +9,45 @@ class TestBasePerInstance < Test::Unit::TestCase
   end
 
   priority :must
+  def test_dn_with_sub_base_first
+    sub_user = @user_class.new(dn: "uid=user1,ou=Sub,#{@user_class.base}",
+                               uid: "user1")
+    # Order is important. #base should be called before #dn.
+    base = sub_user.base.to_s
+    dn = sub_user.dn.to_s
+    assert_equal([
+                   "ou=Sub,#{@user_class.base}",
+                   "uid=user1,ou=Sub,#{@user_class.base}",
+                 ],
+                 [
+                   base,
+                   dn,
+                 ])
+  end
+
+  def test_dn_with_sub_base_last
+    sub_user = @user_class.new(uid: "user1",
+                               dn: "uid=user1,ou=Sub,#{@user_class.base}")
+    # Order is important. #base should be called before #dn.
+    base = sub_user.base.to_s
+    dn = sub_user.dn.to_s
+    assert_equal([
+                   "ou=Sub,#{@user_class.base}",
+                   "uid=user1,ou=Sub,#{@user_class.base}",
+                 ],
+                 [
+                   base,
+                   dn,
+                 ])
+  end
+
+  priority :normal
   def test_set_base
     guest = @user_class.new("guest")
     guest.base = "ou=Sub"
     assert_equal("uid=guest,ou=Sub,#{@user_class.base}", guest.dn)
   end
 
-  priority :normal
   def test_dn_is_base
     entry_class = Class.new(ActiveLdap::Base)
     entry_class.ldap_mapping :prefix => "",

data/test/test_entry.rb

@@ -11,6 +11,7 @@ class TestEntry < Test::Unit::TestCase
         all_entries = [ActiveLdap::Base.base]
         all_entries += [user.dn, user.base]
         all_entries += [group.dn, group.base]
+        all_entries += [@group_of_urls_class.base]
         assert_equal(all_entries.sort,
                      ActiveLdap::Entry.all.collect(&:dn).sort)
       end

data/test/test_validation.rb

@@ -37,6 +37,15 @@ class TestValidation < Test::Unit::TestCase
   priority :must
 
   priority :normal
+  def test_validate_false
+    make_temporary_user(:simple => true) do |user,|
+      user.sn = nil
+      assert_raise(ActiveLdap::RequiredAttributeMissed) do
+        user.save(validate: false)
+      end
+    end
+  end
+
   def test_octet_string
     make_temporary_user(:simple => true) do |user,|
       utf8_encoded_binary_value = "\xff".force_encoding("UTF-8")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeldap
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - Will Drewry
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -279,6 +279,7 @@ files:
 - test/al-test-utils.rb
 - test/command.rb
 - test/config.yaml.sample
+- test/enable-dynamic-groups.ldif
 - test/enable-start-tls.ldif
 - test/fixtures/lower_case_object_class_schema.rb
 - test/run-test.rb
@@ -344,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
+rubygems_version: 3.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: ActiveLdap is a object-oriented API to LDAP
@@ -353,6 +354,7 @@ test_files:
 - test/al-test-utils.rb
 - test/command.rb
 - test/config.yaml.sample
+- test/enable-dynamic-groups.ldif
 - test/enable-start-tls.ldif
 - test/fixtures/lower_case_object_class_schema.rb
 - test/run-test.rb