net-ldap 0.0.5

data/tests/NOTICE.txt

@@ -0,0 +1,6 @@
+Most of the tests here have been migrated to ../test
+where all new tests will be created. These have been
+left here for now just for reference and will me
+migrated as well.
+
+These will not be run automatically by rake.

data/tests/testldap.rb

@@ -0,0 +1,190 @@
+# $Id$
+#
+#
+
+
+$:.unshift "lib"
+
+require 'test/unit'
+
+require 'net/ldap'
+require 'stringio'
+
+
+class TestLdapClient < Test::Unit::TestCase
+
+  # TODO: these tests crash and burn if the associated
+  # LDAP testserver isn't up and running.
+  # We rely on being able to read a file with test data
+  # in LDIF format.
+  # TODO, WARNING: for the moment, this data is in a file
+  # whose name and location are HARDCODED into the
+  # instance method load_test_data.
+
+  def setup
+    @host = "127.0.0.1"
+    @port = 3890
+    @auth = {
+      :method => :simple,
+      :username => "cn=bigshot,dc=bayshorenetworks,dc=com",
+      :password => "opensesame"
+    }
+
+    @ldif = load_test_data
+  end
+
+
+
+  # Get some test data which will be used to validate
+  # the responses from the test LDAP server we will
+  # connect to.
+  # TODO, Bogus: we are HARDCODING the location of the file for now.
+  #
+  def load_test_data
+    ary = File.readlines( "tests/testdata.ldif" )
+    hash = {}
+    while line = ary.shift and line.chomp!
+      if line =~ /^dn:[\s]*/i
+        dn = $'
+        hash[dn] = {}
+        while attr = ary.shift and attr.chomp! and attr =~ /^([\w]+)[\s]*:[\s]*/
+          hash[dn][$1.downcase.intern] ||= []
+          hash[dn][$1.downcase.intern] << $'
+        end
+      end
+    end
+    hash
+  end
+
+
+
+  # Binding tests.
+  # Need tests for all kinds of network failures and incorrect auth.
+  # TODO: Implement a class-level timeout for operations like bind.
+  # Search has a timeout defined at the protocol level, other ops do not.
+  # TODO, use constants for the LDAP result codes, rather than hardcoding them.
+  def test_bind
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => @auth
+    assert_equal( true, ldap.bind )
+    assert_equal( 0, ldap.get_operation_result.code )
+    assert_equal( "Success", ldap.get_operation_result.message )
+
+    bad_username = @auth.merge( {:username => "cn=badguy,dc=imposters,dc=com"} )
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => bad_username
+    assert_equal( false, ldap.bind )
+    assert_equal( 48, ldap.get_operation_result.code )
+    assert_equal( "Inappropriate Authentication", ldap.get_operation_result.message )
+
+    bad_password = @auth.merge( {:password => "cornhusk"} )
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => bad_password
+    assert_equal( false, ldap.bind )
+    assert_equal( 49, ldap.get_operation_result.code )
+    assert_equal( "Invalid Credentials", ldap.get_operation_result.message )
+  end
+
+
+
+  def test_search
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => @auth
+
+    search = {:base => "dc=smalldomain,dc=com"}
+    assert_equal( false, ldap.search( search ))
+    assert_equal( 32, ldap.get_operation_result.code )
+    
+    search = {:base => "dc=bayshorenetworks,dc=com"}
+    assert_equal( true, ldap.search( search ))
+    assert_equal( 0, ldap.get_operation_result.code )
+    
+    ldap.search( search ) {|res|
+      assert_equal( res, @ldif )
+    }
+  end
+    
+
+
+
+  # This is a helper routine for test_search_attributes.
+  def internal_test_search_attributes attrs_to_search
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => @auth
+    assert( ldap.bind )
+
+    search = {
+      :base => "dc=bayshorenetworks,dc=com",
+      :attributes => attrs_to_search
+    }
+
+    ldif = @ldif
+    ldif.each {|dn,entry|
+      entry.delete_if {|attr,value|
+        ! attrs_to_search.include?(attr)
+      }
+    }
+  
+    assert_equal( true, ldap.search( search ))
+    ldap.search( search ) {|res|
+      res_keys = res.keys.sort
+      ldif_keys = ldif.keys.sort
+      assert( res_keys, ldif_keys )
+      res.keys.each {|rk|
+        assert( res[rk], ldif[rk] )
+      }
+    }
+  end
+
+
+  def test_search_attributes
+    internal_test_search_attributes [:mail]
+    internal_test_search_attributes [:cn]
+    internal_test_search_attributes [:ou]
+    internal_test_search_attributes [:hasaccessprivilege]
+    internal_test_search_attributes ["mail"]
+    internal_test_search_attributes ["cn"]
+    internal_test_search_attributes ["ou"]
+    internal_test_search_attributes ["hasaccessrole"]
+
+    internal_test_search_attributes [:mail, :cn, :ou, :hasaccessrole]
+    internal_test_search_attributes [:mail, "cn", :ou, "hasaccessrole"]
+  end
+
+
+  def test_search_filters
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => @auth
+    search = {
+      :base => "dc=bayshorenetworks,dc=com",
+      :filter => Net::LDAP::Filter.eq( "sn", "Fosse" )
+    }
+
+    ldap.search( search ) {|res|
+      p res
+    }
+  end
+
+
+
+  def test_open
+    ldap = Net::LDAP.new :host => @host, :port => @port, :auth => @auth
+    ldap.open {|ldap|
+      10.times {
+        rc = ldap.search( :base => "dc=bayshorenetworks,dc=com" )
+        assert_equal( true, rc )
+      }
+    }
+  end
+
+
+  def test_ldap_open
+    Net::LDAP.open( :host => @host, :port => @port, :auth => @auth ) {|ldap|
+      10.times {
+        rc = ldap.search( :base => "dc=bayshorenetworks,dc=com" )
+        assert_equal( true, rc )
+      }
+    }
+  end
+
+
+
+
+
+end
+
+

data/testserver/ldapserver.rb

@@ -0,0 +1,229 @@
+# $Id$
+#
+# Copyright (C) 2006 by Francis Cianfrocca. All Rights Reserved.
+# Gmail account: garbagecat10.
+#
+# This is an LDAP server intended for unit testing of Net::LDAP.
+# It implements as much of the protocol as we have the stomach
+# to implement but serves static data. Use ldapsearch to test
+# this server!
+#
+# To make this easier to write, we use the Ruby/EventMachine
+# reactor library.
+#
+
+
+require 'stringio'
+
+#------------------------------------------------
+
+class String
+  def read_ber! syntax=nil
+    s = StringIO.new self
+    pdu = s.read_ber(syntax)
+    if pdu
+      if s.eof?
+        slice!(0, length)
+      else
+        slice!(0, length - s.read.length)
+      end
+    end
+    pdu
+  end
+end
+
+
+module LdapServer
+
+  LdapServerAsnSyntax = {
+    :application => {
+      :constructed => {
+        0 => :array,               # LDAP BindRequest
+        3 => :array                # LDAP SearchRequest
+      },
+      :primitive => {
+        2 => :string,              # ldapsearch sends this to unbind
+      }
+    },
+    :context_specific => {
+      :primitive => {
+        0 => :string,              # simple auth (password)
+        7 => :string               # present filter
+      },
+      :constructed => {
+        3 => :array                # equality filter
+      },
+    }
+  }
+
+  def post_init
+    $logger.info "Accepted LDAP connection"
+    @authenticated = false
+  end
+
+  def receive_data data
+    @data ||= ""; @data << data
+    while pdu = @data.read_ber!(LdapServerAsnSyntax)
+      begin
+      handle_ldap_pdu pdu
+      rescue
+        $logger.error "closing connection due to error #{$!}"
+        close_connection
+      end
+    end
+  end
+
+  def handle_ldap_pdu pdu
+    tag_id = pdu[1].ber_identifier
+    case tag_id
+    when 0x60
+      handle_bind_request pdu
+    when 0x63
+      handle_search_request pdu
+    when 0x42
+      # bizarre thing, it's a null object (primitive application-2)
+      # sent by ldapsearch to request an unbind (or a kiss-off, not sure which)
+      close_connection_after_writing
+    else
+      $logger.error "received unknown packet-type #{tag_id}"
+      close_connection_after_writing
+    end
+  end
+
+  def handle_bind_request pdu
+    # TODO, return a proper LDAP error instead of blowing up on version error
+    if pdu[1][0] != 3
+      send_ldap_response 1, pdu[0].to_i, 2, "", "We only support version 3"
+    elsif pdu[1][1] != "cn=bigshot,dc=bayshorenetworks,dc=com"
+      send_ldap_response 1, pdu[0].to_i, 48, "", "Who are you?"
+    elsif pdu[1][2].ber_identifier != 0x80
+      send_ldap_response 1, pdu[0].to_i, 7, "", "Keep it simple, man"
+    elsif pdu[1][2] != "opensesame"
+      send_ldap_response 1, pdu[0].to_i, 49, "", "Make my day"
+    else
+      @authenticated = true
+      send_ldap_response 1, pdu[0].to_i, 0, pdu[1][1], "I'll take it"
+    end
+  end
+
+
+
+  #--
+  # Search Response ::=
+  #       CHOICE {
+  #            entry          [APPLICATION 4] SEQUENCE {
+  #                                objectName     LDAPDN,
+  #                                attributes     SEQUENCE OF SEQUENCE {
+  #                                                    AttributeType,
+  #                                                    SET OF AttributeValue
+  #                                               }
+  #                           },
+  #            resultCode     [APPLICATION 5] LDAPResult
+  #        }
+  def handle_search_request pdu
+    unless @authenticated
+      # NOTE, early exit.
+      send_ldap_response 5, pdu[0].to_i, 50, "", "Who did you say you were?"
+      return
+    end
+
+    treebase = pdu[1][0]
+    if treebase != "dc=bayshorenetworks,dc=com"
+      send_ldap_response 5, pdu[0].to_i, 32, "", "unknown treebase"
+      return
+    end
+
+    msgid = pdu[0].to_i.to_ber
+
+    # pdu[1][7] is the list of requested attributes.
+    # If it's an empty array, that means that *all* attributes were requested.
+    requested_attrs = if pdu[1][7].length > 0
+      pdu[1][7].map {|a| a.downcase}
+    else
+      :all
+    end
+
+    filters = pdu[1][6]
+    if filters.length == 0
+      # NOTE, early exit.
+      send_ldap_response 5, pdu[0].to_i, 53, "", "No filter specified"
+    end
+
+    # TODO, what if this returns nil?
+    filter = Net::LDAP::Filter.parse_ldap_filter( filters )
+
+    $ldif.each {|dn, entry|
+      if filter.match( entry )
+        attrs = []
+        entry.each {|k, v|
+          if requested_attrs == :all or requested_attrs.include?(k.downcase)
+            attrvals = v.map {|v1| v1.to_ber}.to_ber_set
+            attrs << [k.to_ber, attrvals].to_ber_sequence
+          end
+        }
+
+        appseq = [dn.to_ber, attrs.to_ber_sequence].to_ber_appsequence(4)
+        pkt = [msgid.to_ber, appseq].to_ber_sequence
+        send_data pkt
+      end
+    }
+
+
+    send_ldap_response 5, pdu[0].to_i, 0, "", "Was that what you wanted?"
+  end
+
+
+
+  def send_ldap_response pkt_tag, msgid, code, dn, text
+    send_data( [msgid.to_ber, [code.to_ber, dn.to_ber, text.to_ber].to_ber_appsequence(pkt_tag) ].to_ber )
+  end
+
+end
+
+
+#------------------------------------------------
+
+# Rather bogus, a global method, which reads a HARDCODED filename
+# parses out LDIF data. It will be used to serve LDAP queries out of this server.
+#
+def load_test_data
+  ary = File.readlines( "./testdata.ldif" )
+  hash = {}
+  while line = ary.shift and line.chomp!
+    if line =~ /^dn:[\s]*/i
+      dn = $'
+      hash[dn] = {}
+      while attr = ary.shift and attr.chomp! and attr =~ /^([\w]+)[\s]*:[\s]*/
+        hash[dn][$1.downcase] ||= []
+        hash[dn][$1.downcase] << $'
+      end
+    end
+  end
+  hash
+end
+
+
+#------------------------------------------------
+
+if __FILE__ == $0
+
+  require 'rubygems'
+  require 'eventmachine'
+
+  require 'logger'
+  $logger = Logger.new $stderr
+
+  $logger.info "adding ../lib to loadpath, to pick up dev version of Net::LDAP."
+  $:.unshift "../lib"
+
+  $ldif = load_test_data
+
+  require 'net/ldap'
+
+  EventMachine.run {
+    $logger.info "starting LDAP server on 127.0.0.1 port 3890"
+    EventMachine.start_server "127.0.0.1", 3890, LdapServer
+    EventMachine.add_periodic_timer 60, proc {$logger.info "heartbeat"}
+  }
+end
+

data/testserver/testdata.ldif

@@ -0,0 +1,101 @@
+# $Id$
+#
+# This is test-data for an LDAP server in LDIF format.
+#
+dn: dc=bayshorenetworks,dc=com
+objectClass: dcObject
+objectClass: organization
+o: Bayshore Networks LLC
+dc: bayshorenetworks
+
+dn: cn=Manager,dc=bayshorenetworks,dc=com
+objectClass: organizationalrole
+cn: Manager
+
+dn: ou=people,dc=bayshorenetworks,dc=com
+objectClass: organizationalunit
+ou: people
+
+dn: ou=privileges,dc=bayshorenetworks,dc=com
+objectClass: organizationalunit
+ou: privileges
+
+dn: ou=roles,dc=bayshorenetworks,dc=com
+objectClass: organizationalunit
+ou: roles
+
+dn: ou=office,dc=bayshorenetworks,dc=com
+objectClass: organizationalunit
+ou: office
+
+dn: mail=nogoodnik@steamheat.net,ou=people,dc=bayshorenetworks,dc=com
+cn: Bob Fosse
+mail: nogoodnik@steamheat.net
+sn: Fosse
+ou: people
+objectClass: top
+objectClass: inetorgperson
+objectClass: authorizedperson
+hasAccessRole: uniqueIdentifier=engineer,ou=roles
+hasAccessRole: uniqueIdentifier=ldapadmin,ou=roles
+hasAccessRole: uniqueIdentifier=ldapsuperadmin,ou=roles
+hasAccessRole: uniqueIdentifier=ogilvy_elephant_user,ou=roles
+hasAccessRole: uniqueIdentifier=ogilvy_eagle_user,ou=roles
+hasAccessRole: uniqueIdentifier=greenplug_user,ou=roles
+hasAccessRole: uniqueIdentifier=brandplace_logging_user,ou=roles
+hasAccessRole: uniqueIdentifier=brandplace_report_user,ou=roles
+hasAccessRole: uniqueIdentifier=workorder_user,ou=roles
+hasAccessRole: uniqueIdentifier=bayshore_eagle_user,ou=roles
+hasAccessRole: uniqueIdentifier=bayshore_eagle_superuser,ou=roles
+hasAccessRole: uniqueIdentifier=kledaras_user,ou=roles
+
+dn: mail=elephant@steamheat.net,ou=people,dc=bayshorenetworks,dc=com
+cn: Gwen Verdon
+mail: elephant@steamheat.net
+sn: Verdon
+ou: people
+objectClass: top
+objectClass: inetorgperson
+objectClass: authorizedperson
+hasAccessRole: uniqueIdentifier=brandplace_report_user,ou=roles
+hasAccessRole: uniqueIdentifier=engineer,ou=roles
+hasAccessRole: uniqueIdentifier=ogilvy_elephant_user,ou=roles
+hasAccessRole: uniqueIdentifier=ldapsuperadmin,ou=roles
+hasAccessRole: uniqueIdentifier=ldapadmin,ou=roles
+
+dn: uniqueIdentifier=engineering,ou=privileges,dc=bayshorenetworks,dc=com
+uniqueIdentifier: engineering
+ou: privileges
+objectClass: accessPrivilege
+
+dn: uniqueIdentifier=engineer,ou=roles,dc=bayshorenetworks,dc=com
+uniqueIdentifier: engineer
+ou: roles
+objectClass: accessRole
+hasAccessPrivilege: uniqueIdentifier=engineering,ou=privileges
+
+dn: uniqueIdentifier=ldapadmin,ou=roles,dc=bayshorenetworks,dc=com
+uniqueIdentifier: ldapadmin
+ou: roles
+objectClass: accessRole
+
+dn: uniqueIdentifier=ldapsuperadmin,ou=roles,dc=bayshorenetworks,dc=com
+uniqueIdentifier: ldapsuperadmin
+ou: roles
+objectClass: accessRole
+
+dn: mail=catperson@steamheat.net,ou=people,dc=bayshorenetworks,dc=com
+cn: Sid Sorokin
+mail: catperson@steamheat.net
+sn: Sorokin
+ou: people
+objectClass: top
+objectClass: inetorgperson
+objectClass: authorizedperson
+hasAccessRole: uniqueIdentifier=engineer,ou=roles
+hasAccessRole: uniqueIdentifier=ogilvy_elephant_user,ou=roles
+hasAccessRole: uniqueIdentifier=ldapsuperadmin,ou=roles
+hasAccessRole: uniqueIdentifier=ogilvy_eagle_user,ou=roles
+hasAccessRole: uniqueIdentifier=greenplug_user,ou=roles
+hasAccessRole: uniqueIdentifier=workorder_user,ou=roles
+