scashin133-net-ldap 0.1.2

data/lib/net/ldif.rb

@@ -0,0 +1,34 @@
+# $Id$
+#
+# Net::LDIF for Ruby
+#
+#
+#
+# Copyright (C) 2006 by Francis Cianfrocca. All Rights Reserved.
+#
+# Gmail: garbagecat10
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+#
+
+# THIS FILE IS A STUB.
+
+module Net
+  class LDIF
+  end
+end
+
+

data/lib/net/snmp.rb

@@ -0,0 +1,295 @@
+# $Id$
+#
+# NET::SNMP
+#
+#----------------------------------------------------------------------------
+#
+# Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
+#
+# Gmail: garbagecat10
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+#---------------------------------------------------------------------------
+#
+#
+
+module Net
+
+    class SNMP
+      VERSION = '0.1.0'
+
+	AsnSyntax = Net::BER.compile_syntax({
+	    :application => {
+		:primitive => {
+		    1 => :integer,	# Counter32, (RFC2578 sec 2)
+		    2 => :integer,	# Gauge32 or Unsigned32, (RFC2578 sec 2)
+		    3 => :integer	# TimeTicks32, (RFC2578 sec 2)
+		},
+		:constructed => {
+		}
+	    },
+	    :context_specific => {
+		:primitive => {
+		},
+		:constructed => {
+		    0 => :array,	# GetRequest PDU (RFC1157 pgh 4.1.2)
+		    1 => :array,	# GetNextRequest PDU (RFC1157 pgh 4.1.3)
+		    2 => :array		# GetResponse PDU (RFC1157 pgh 4.1.4)
+		}
+	    }
+	})
+
+	# SNMP 32-bit counter.
+	# Defined in RFC1155 (Structure of Mangement Information), section 6.
+	# A 32-bit counter is an ASN.1 application [1] implicit unsigned integer
+	# with a range from 0 to 2^^32 - 1.
+	class Counter32
+	    def initialize value
+		@value = value
+	    end
+	    def to_ber
+		@value.to_ber_application(1)
+	    end
+	end
+
+	# SNMP 32-bit gauge.
+	# Defined in RFC1155 (Structure of Mangement Information), section 6.
+	# A 32-bit counter is an ASN.1 application [2] implicit unsigned integer.
+	# This is also indistinguishable from Unsigned32. (Need to alias them.)
+	class Gauge32
+	    def initialize value
+		@value = value
+	    end
+	    def to_ber
+		@value.to_ber_application(2)
+	    end
+	end
+
+	# SNMP 32-bit timer-ticks.
+	# Defined in RFC1155 (Structure of Mangement Information), section 6.
+	# A 32-bit counter is an ASN.1 application [3] implicit unsigned integer.
+	class TimeTicks32
+	    def initialize value
+		@value = value
+	    end
+	    def to_ber
+		@value.to_ber_application(3)
+	    end
+	end
+    end
+
+    class SnmpPdu
+	class Error < StandardError; end
+
+	PduTypes = [
+	    :get_request,
+	    :get_next_request,
+	    :get_response,
+	    :set_request,
+	    :trap
+	]
+	ErrorStatusCodes = { # Per RFC1157, pgh 4.1.1
+	    0 => "noError",
+	    1 => "tooBig",
+	    2 => "noSuchName",
+	    3 => "badValue",
+	    4 => "readOnly",
+	    5 => "genErr"
+	}
+
+	class << self
+	    def parse ber_object
+		n = new
+		n.send :parse, ber_object
+		n
+	    end
+	end
+
+	attr_reader :version, :community, :pdu_type, :variables, :error_status
+	attr_accessor :request_id, :error_index
+
+
+	def initialize args={}
+	    @version = args[:version] || 0
+	    @community = args[:community] || "public"
+	    @pdu_type = args[:pdu_type] # leave nil unless specified; there's no reasonable default value.
+	    @error_status = args[:error_status] || 0
+	    @error_index = args[:error_index] || 0
+	    @variables = args[:variables] || []
+	end
+
+	#--
+	def parse ber_object
+	    begin
+		parse_ber_object ber_object
+	    rescue Error
+		# Pass through any SnmpPdu::Error instances
+		raise $!
+	    rescue
+		# Wrap any basic parsing error so it becomes a PDU-format error
+		raise Error.new( "snmp-pdu format error" )
+	    end
+	end
+	private :parse
+
+	def parse_ber_object ber_object
+	    send :version=, ber_object[0].to_i
+	    send :community=, ber_object[1].to_s
+
+	    data = ber_object[2]
+	    case (app_tag = data.ber_identifier & 31)
+	    when 0
+		send :pdu_type=, :get_request
+		parse_get_request data
+	    when 1
+		send :pdu_type=, :get_next_request
+		# This PDU is identical to get-request except for the type.
+		parse_get_request data
+	    when 2
+		send :pdu_type=, :get_response
+		# This PDU is identical to get-request except for the type,
+		# the error_status and error_index values are meaningful,
+		# and the fact that the variable bindings will be non-null.
+		parse_get_response data
+	    else
+		raise Error.new( "unknown snmp-pdu type: #{app_tag}" )
+	    end
+	end
+	private :parse_ber_object
+
+	#--
+	# Defined in RFC1157, pgh 4.1.2.
+	def parse_get_request data
+	    send :request_id=, data[0].to_i
+	    # data[1] is error_status, always zero.
+	    # data[2] is error_index, always zero.
+	    send :error_status=, 0
+	    send :error_index=, 0
+	    data[3].each {|n,v|
+		# A variable-binding, of which there may be several,
+		# consists of an OID and a BER null.
+		# We're ignoring the null, we might want to verify it instead.
+		unless v.is_a?(Net::BER::BerIdentifiedNull)
+		    raise Error.new(" invalid variable-binding in get-request" )
+		end
+		add_variable_binding n, nil
+	    }
+	end
+	private :parse_get_request
+
+	#--
+	# Defined in RFC1157, pgh 4.1.4
+	def parse_get_response data
+	    send :request_id=, data[0].to_i
+	    send :error_status=, data[1].to_i
+	    send :error_index=, data[2].to_i
+	    data[3].each {|n,v|
+		# A variable-binding, of which there may be several,
+		# consists of an OID and a BER null.
+		# We're ignoring the null, we might want to verify it instead.
+		add_variable_binding n, v
+	    }
+	end
+	private :parse_get_response
+
+
+	def version= ver
+	    unless [0,2].include?(ver)
+		raise Error.new("unknown snmp-version: #{ver}")
+	    end
+	    @version = ver
+	end
+
+	def pdu_type= t
+	    unless PduTypes.include?(t)
+		raise Error.new("unknown pdu-type: #{t}")
+	    end
+	    @pdu_type = t
+	end
+
+	def error_status= es
+	    unless ErrorStatusCodes.has_key?(es)
+		raise Error.new("unknown error-status: #{es}")
+	    end
+	    @error_status = es
+	end
+
+	def community= c
+	    @community = c.to_s
+	end
+
+	#--
+	# Syntactic sugar
+	def add_variable_binding name, value=nil
+	    @variables ||= []
+	    @variables << [name, value]
+	end
+
+	def to_ber_string
+	    [
+		version.to_ber,
+		community.to_ber,
+		pdu_to_ber_string
+	    ].to_ber_sequence
+	end
+
+	#--
+	# Helper method that returns a PDU payload in BER form,
+	# depending on the PDU type.
+	def pdu_to_ber_string
+	    case pdu_type
+	    when :get_request
+		[
+		    request_id.to_ber,
+		    error_status.to_ber,
+		    error_index.to_ber,
+		    [
+			@variables.map {|n,v|
+			    [n.to_ber_oid, Net::BER::BerIdentifiedNull.new.to_ber].to_ber_sequence
+			}
+		    ].to_ber_sequence
+		].to_ber_contextspecific(0)
+	    when :get_next_request
+		[
+		    request_id.to_ber,
+		    error_status.to_ber,
+		    error_index.to_ber,
+		    [
+			@variables.map {|n,v|
+			    [n.to_ber_oid, Net::BER::BerIdentifiedNull.new.to_ber].to_ber_sequence
+			}
+		    ].to_ber_sequence
+		].to_ber_contextspecific(1)
+	    when :get_response
+		[
+		    request_id.to_ber,
+		    error_status.to_ber,
+		    error_index.to_ber,
+		    [
+			@variables.map {|n,v|
+			    [n.to_ber_oid, v.to_ber].to_ber_sequence
+			}
+		    ].to_ber_sequence
+		].to_ber_contextspecific(2)
+	    else
+		raise Error.new( "unknown pdu-type: #{pdu_type}" )
+	    end
+	end
+	private :pdu_to_ber_string
+
+    end
+end
+

data/lib/net-ldap.rb

@@ -0,0 +1 @@
+require 'net/ldap'

data/spec/integration/ssl_ber_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+require 'net/ldap'
+
+describe "BER serialisation (SSL)" do
+  # Transmits str to #to and reads it back from #from. 
+  #
+  def transmit(str)
+    to.write(str)
+    to.close
+    
+    from.read
+  end
+    
+  attr_reader :to, :from
+  before(:each) do
+    @from, @to = IO.pipe
+    
+    flexmock(OpenSSL::SSL::SSLSocket).
+      new_instances.should_receive(:connect => nil)
+              
+    @to   = Net::LDAP::Connection.wrap_with_ssl(to)
+    @from = Net::LDAP::Connection.wrap_with_ssl(from)
+  end
+  
+  it "should transmit strings" do
+    transmit('foo').should == 'foo'
+  end 
+  it "should correctly transmit numbers" do
+    to.write 1234.to_ber
+    from.read_ber.should == 1234
+  end 
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'net/ldap'
+require 'rubygems'
+
+Spec::Runner.configure do |config|
+  config.mock_with :flexmock
+end

data/spec/unit/ber/ber_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+require 'net/ber'
+require 'net/ldap'
+
+describe "BER encoding of" do
+  def properly_encode_and_decode
+    simple_matcher('properly encode and decode') do |given|
+      given.to_ber.read_ber.should == given
+    end
+  end
+  
+  context "arrays" do
+    it "should properly encode/decode []" do
+      [].should properly_encode_and_decode
+    end 
+    it "should properly encode/decode [1,2,3]" do
+      ary = [1,2,3]
+      encoded_ary = ary.map { |el| el.to_ber }.to_ber
+      
+      encoded_ary.read_ber.should == ary
+    end 
+  end
+  context "booleans" do
+    it "should encode true" do
+      true.to_ber.should == "\x01\x01\x01"
+    end
+    it "should encode false" do
+      false.to_ber.should == "\x01\x01\x00"
+    end
+  end
+  context "numbers" do
+    # Sample based
+    {
+      0           => "\x02\x01\x00", 
+      1           => "\x02\x01\x01", 
+      127         => "\x02\x01\x7F", 
+      128         => "\x02\x01\x80", 
+      255         => "\x02\x01\xFF", 
+      256         => "\x02\x02\x01\x00", 
+      65535       => "\x02\x02\xFF\xFF", 
+      65536       => "\x02\x03\x01\x00\x00", 
+      16_777_215  => "\x02\x03\xFF\xFF\xFF", 
+      0x01000000  => "\x02\x04\x01\x00\x00\x00", 
+      0x3FFFFFFF  => "\x02\x04\x3F\xFF\xFF\xFF", 
+      0x4FFFFFFF  => "\x02\x04\x4F\xFF\xFF\xFF", 
+      
+      # Some odd samples...
+      5           => "\002\001\005", 
+      500         => "\002\002\001\364", 
+      50_000      => "\x02\x02\xC3P", 
+      5_000_000_000  => "\002\005\001*\005\362\000"
+    }.each do |number, expected_encoding| 
+      it "should encode #{number} as #{expected_encoding.inspect}" do
+        number.to_ber.should == expected_encoding
+      end 
+    end
+
+    # Round-trip encoding: This is mostly to be sure to cover Bignums well.
+    context "when decoding with #read_ber" do
+      it "should correctly handle powers of two" do
+        100.times do |p|
+          n = 2 << p
+          
+          n.should properly_encode_and_decode
+        end
+      end 
+      it "should correctly handle powers of ten" do
+        100.times do |p|
+          n = 5 * 10**p
+          
+          n.should properly_encode_and_decode
+        end
+      end 
+    end
+  end
+end
+
+describe "BER decoding of" do
+  context "numbers" do
+    it "should decode #{"\002\001\006".inspect} (6)" do
+      "\002\001\006".read_ber(Net::LDAP::AsnSyntax).should == 6
+    end
+    it "should decode #{"\004\007testing".inspect} ('testing')" do
+      "\004\007testing".read_ber(Net::LDAP::AsnSyntax).should == 'testing'
+    end
+    it "should decode an ldap bind request" do
+      "0$\002\001\001`\037\002\001\003\004\rAdministrator\200\vad_is_bogus".
+        read_ber(Net::LDAP::AsnSyntax).should ==
+          [1, [3, "Administrator", "ad_is_bogus"]]
+    end 
+  end
+end

data/spec/unit/ber/core_ext/string_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'metaid'
+
+describe String, "when extended with BER core extensions" do
+  describe "<- #read_ber! (consuming read_ber method)" do
+    context "when passed an ldap bind request and some extra data" do
+      attr_reader :str, :result
+      before(:each) do
+        @str = "0$\002\001\001`\037\002\001\003\004\rAdministrator\200\vad_is_bogus UNCONSUMED" 
+        @result = str.read_ber!(Net::LDAP::AsnSyntax)
+      end
+      
+      it "should correctly parse the ber message" do
+        result.should == [1, [3, "Administrator", "ad_is_bogus"]]
+      end 
+      it "should leave unconsumed part of message in place" do
+        str.should == " UNCONSUMED"
+      end
+
+      context "if an exception occurs during #read_ber" do
+        attr_reader :initial_value
+        before(:each) do
+          stub_exception_class = Class.new(StandardError)
+          
+          @initial_value = "0$\002\001\001`\037\002\001\003\004\rAdministrator\200\vad_is_bogus" 
+          @str = initial_value.dup 
+
+          # Defines a string
+          io = StringIO.new(initial_value)
+          io.meta_def :read_ber do |syntax|
+            read
+            raise stub_exception_class
+          end
+          flexmock(StringIO).should_receive(:new).and_return(io)
+          
+          begin
+            str.read_ber!(Net::LDAP::AsnSyntax)            
+          rescue stub_exception_class
+            # EMPTY ON PURPOSE
+          else
+            raise "The stub code should raise an exception!"
+          end
+        end
+        
+        it "should not modify string" do
+          str.should == initial_value
+        end
+      end
+    end
+  end
+end

data/spec/unit/ldap/entry_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Net::LDAP::Entry do
+  attr_reader :entry
+  before(:each) do
+    @entry = Net::LDAP::Entry.from_single_ldif_string(
+      %Q{dn: something
+foo: foo
+barAttribute: bar
+      }
+    )
+  end
+
+  describe "entry access" do
+    it "should always respond to #dn" do
+      entry.should respond_to(:dn)
+    end 
+    
+    context "<- #foo" do
+      it "should respond_to?" do
+        entry.should respond_to(:foo)
+      end 
+      it "should return 'foo'" do
+        entry.foo.should == ['foo']
+      end
+    end
+    context "<- #Foo" do
+      it "should respond_to?" do
+        entry.should respond_to(:Foo)
+      end 
+      it "should return 'foo'" do
+        entry.foo.should == ['foo']
+      end 
+    end
+    context "<- #foo=" do
+      it "should respond_to?" do
+        entry.should respond_to(:foo=)
+      end 
+      it "should set 'foo'" do
+        entry.foo= 'bar'
+        entry.foo.should == ['bar']
+      end 
+    end
+    context "<- #fOo=" do
+      it "should return 'foo'" do
+        entry.fOo= 'bar'
+        entry.fOo.should == ['bar']
+      end 
+    end
+  end
+end

data/spec/unit/ldap/filter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Net::LDAP::Filter do
+  describe "<- .ex(attr, value)" do
+    context "('foo', 'bar')" do
+      attr_reader :filter
+      before(:each) do
+        @filter = Net::LDAP::Filter.ex('foo', 'bar')
+      end
+      it "should convert to 'foo:=bar'" do
+        filter.to_s.should == '(foo:=bar)'
+      end 
+      it "should survive roundtrip via to_s/from_rfc2254" do
+        Net::LDAP::Filter.from_rfc2254(filter.to_s).should == filter
+      end 
+      it "should survive roundtrip conversion to/from ber" do
+        ber = filter.to_ber
+        Net::LDAP::Filter.parse_ber(ber.read_ber(Net::LDAP::AsnSyntax)).should ==
+          filter
+      end 
+    end
+    context "various legal inputs" do
+      [
+        '(o:dn:=Ace Industry)', 
+        '(:dn:2.4.8.10:=Dino)', 
+        '(cn:dn:1.2.3.4.5:=John Smith)', 
+        '(sn:dn:2.4.6.8.10:=Barbara Jones)', 
+      ].each do |filter_str|
+        context "from_rfc2254(#{filter_str.inspect})" do
+          attr_reader :filter
+          before(:each) do
+            @filter = Net::LDAP::Filter.from_rfc2254(filter_str)
+          end
+
+          it "should decode into a Net::LDAP::Filter" do
+            filter.should be_an_instance_of(Net::LDAP::Filter)
+          end 
+          it "should survive roundtrip conversion to/from ber" do
+            ber = filter.to_ber
+            Net::LDAP::Filter.parse_ber(ber.read_ber(Net::LDAP::AsnSyntax)).should ==
+              filter
+          end 
+        end
+      end
+    end
+  end
+  
+end

data/spec/unit/ldap_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Net::LDAP::Connection do
+  describe "initialize" do
+    context "when host is not responding" do
+      before(:each) do
+        flexmock(TCPSocket).
+          should_receive(:new).and_raise(Errno::ECONNREFUSED)
+      end
+      
+      it "should raise LdapError" do
+        lambda {
+          Net::LDAP::Connection.new(
+            :server => 'test.mocked.com', 
+            :port   => 636)
+        }.should raise_error(Net::LDAP::LdapError)
+      end
+    end
+    context "when host is blocking the port" do
+      before(:each) do
+        flexmock(TCPSocket).
+          should_receive(:new).and_raise(SocketError)
+      end
+      
+      it "should raise LdapError" do
+        lambda {
+          Net::LDAP::Connection.new(
+            :server => 'test.mocked.com', 
+            :port   => 636)
+        }.should raise_error(Net::LDAP::LdapError)
+      end
+    end
+    context "on other exceptions" do
+      before(:each) do
+        flexmock(TCPSocket).
+          should_receive(:new).and_raise(NameError)
+      end
+      
+      it "should rethrow the exception" do
+        lambda {
+          Net::LDAP::Connection.new(
+            :server => 'test.mocked.com', 
+            :port   => 636)
+        }.should raise_error(NameError)
+      end
+    end
+  end
+end

data/test/common.rb

@@ -0,0 +1,3 @@
+# Add 'lib' to load path.
+require 'test/unit'
+require 'net/ldap'