scashin133-net-ldap 0.1.2

data/Rakefile

@@ -0,0 +1,124 @@
+require "rubygems"
+require 'hanna/rdoctask'
+require 'hoe'
+
+$LOAD_PATH.unshift('lib')
+
+require 'net/ldap'
+
+PKG_NAME    = 'scashin133-net-ldap'
+PKG_VERSION = Net::LDAP::VERSION
+PKG_DIST    = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_TAR     = "pkg/#{PKG_DIST}.tar.gz"
+MANIFEST    = File.read("Manifest.txt").split
+MINRUBY     = "1.8.7"
+
+Hoe.plugin :git
+Hoe.spec PKG_NAME do
+  self.version = PKG_VERSION
+  self.rubyforge_name = PKG_NAME
+
+  developer "Francis Cianfrocca", "blackhedd@rubyforge.org"
+  developer "Emiel van de Laar", "gemiel@gmail.com"
+  developer "Rory O'Connell", "rory.ocon@gmail.com"
+  developer "Kaspar Schiess", "kaspar.schiess@absurd.li"
+  developer "Austin Ziegler", "austin@rubyforge.org" 
+
+  self.remote_rdoc_dir = ''
+  rsync_args << ' --exclude=statsvn/'
+
+  self.url = %W(http://net-ldap.rubyforge.org/ http://github.com/RoryO/ruby-net-ldap)
+
+  self.summary = "Pure Ruby LDAP support library with most client features and some server features."
+  self.changes = paragraphs_of(self.history_file, 0..1).join("\n\n")
+  self.description = paragraphs_of(self.readme_file, 2..2).join("\n\n")
+
+  extra_rdoc_files << "Hacking.rdoc"
+
+  extra_dev_deps << [ "archive-tar-minitar", "~>0.5.1" ]
+  extra_dev_deps << [ "hanna", "~>0.1.2" ]
+  extra_dev_deps << [ "hoe-git", "~>1" ]
+  extra_dev_deps << [ "metaid", "~>1" ]
+  clean_globs << "coverage"
+
+  spec_extras[:required_ruby_version] = ">= #{MINRUBY}"
+  multiruby_skip << "1.8.6"
+  multiruby_skip << "1_8_6"
+
+  # This is a lie because I will continue to use Archive::Tar::Minitar.
+  self.need_tar        = false
+end
+
+desc "Build a Net-LDAP .tar.gz distribution."
+task :tar => [ PKG_TAR ]
+file PKG_TAR => [ :test ] do |t|
+  require 'archive/tar/minitar'
+  require 'zlib'
+  files = MANIFEST.map { |f|
+    fn = File.join(PKG_DIST, f)
+    tm = File.stat(f).mtime
+
+    if File.directory?(f)
+      { :name => fn, :mode => 0755, :dir => true, :mtime => tm }
+    else
+      mode = if f =~ %r{^bin}
+               0755
+             else
+               0644
+             end
+      data = File.read(f)
+      { :name => fn, :mode => mode, :data => data, :size => data.size,
+        :mtime => tm }
+    end
+  }
+
+  begin
+    unless File.directory?(File.dirname(t.name))
+      require 'fileutils'
+      File.mkdir_p File.dirname(t.name)
+    end
+    tf = File.open(t.name, 'wb')
+    gz = Zlib::GzipWriter.new(tf)
+    tw = Archive::Tar::Minitar::Writer.new(gz)
+
+    files.each do |entry|
+      if entry[:dir]
+        tw.mkdir(entry[:name], entry)
+      else
+        tw.add_file_simple(entry[:name], entry) { |os|
+          os.write(entry[:data])
+        }
+      end
+    end
+  ensure
+    tw.close if tw
+    gz.close if gz
+  end
+end
+task :package => [ PKG_TAR ]
+
+desc "Build the manifest file from the current set of files."
+task :build_manifest do |t|
+  require 'find'
+
+  paths = []
+  Find.find(".") do |path|
+    next if File.directory?(path)
+    next if path =~ /\.svn/
+    next if path =~ /\.git/
+    next if path =~ /\.hoerc/
+    next if path =~ /\.swp$/
+    next if path =~ %r{coverage/}
+    next if path =~ /~$/
+    paths << path.sub(%r{^\./}, '')
+  end
+
+  File.open("Manifest.txt", "w") do |f|
+    f.puts paths.sort.join("\n")
+  end
+
+  puts paths.sort.join("\n")
+end
+
+desc "Run a full set of integration and unit tests" 
+task :cruise => [:test, :spec]

data/lib/net/ber/ber_parser.rb

@@ -0,0 +1,168 @@
+require 'stringio'
+
+##
+# Implements Basic Encoding Rules parsing to be mixed into types as needed.
+module Net::BER::BERParser
+  primitive = {
+    1 => :boolean,
+    2 => :integer,
+    4 => :string,
+    5 => :null,
+    6 => :oid,
+    10 => :integer,
+    13 => :string # (relative OID)
+  }
+  constructed = {
+    16 => :array,
+    17 => :array
+  }
+  universal = { :primitive => primitive, :constructed => constructed }
+
+  primitive = { 10 => :integer }
+  context =  { :primitive => primitive }
+
+  # The universal, built-in ASN.1 BER syntax.
+  BuiltinSyntax = Net::BER.compile_syntax(:universal => universal,
+                                          :context_specific => context)
+
+  ##
+  # This is an extract of our BER object parsing to simplify our
+  # understanding of how we parse basic BER object types.
+  def parse_ber_object(syntax, id, data)
+    # Find the object type from either the provided syntax lookup table or
+    # the built-in syntax lookup table.
+    #
+    # This exceptionally clever bit of code is verrrry slow.
+    object_type = (syntax && syntax[id]) || BuiltinSyntax[id]
+
+    # == is expensive so sort this so the common cases are at the top.
+    if object_type == :string
+      s = Net::BER::BerIdentifiedString.new(data || "")
+      s.ber_identifier = id
+      s
+    elsif object_type == :integer
+      j = 0
+      data.each_byte { |b| j = (j << 8) + b }
+      j
+    elsif object_type == :oid
+      # See X.690 pgh 8.19 for an explanation of this algorithm.
+      # This is potentially not good enough. We may need a
+      # BerIdentifiedOid as a subclass of BerIdentifiedArray, to
+      # get the ber identifier and also a to_s method that produces
+      # the familiar dotted notation.
+      oid = data.unpack("w*")
+      f = oid.shift
+      g = if f < 40
+            [0, f]
+          elsif f < 80
+            [1, f - 40]
+          else
+            # f - 80 can easily be > 80. What a weird optimization.
+            [2, f - 80]
+          end
+      oid.unshift g.last
+      oid.unshift g.first
+      # Net::BER::BerIdentifiedOid.new(oid)
+      oid
+    elsif object_type == :array
+      seq = Net::BER::BerIdentifiedArray.new
+      seq.ber_identifier = id
+      sio = StringIO.new(data || "")
+      # Interpret the subobject, but note how the loop is built:
+      # nil ends the loop, but false (a valid BER value) does not!
+      while (e = sio.read_ber(syntax)) != nil
+        seq << e
+      end
+      seq
+    elsif object_type == :boolean
+      data != "\000"
+    elsif object_type == :null
+      n = Net::BER::BerIdentifiedNull.new
+      n.ber_identifier = id
+      n
+    else
+      raise Net::BER::BerError, "Unsupported object type: id=#{id}"
+    end
+  end
+  private :parse_ber_object
+
+  ##
+  # This is an extract of how our BER object length parsing is done to
+  # simplify the primary call. This is defined in X.690 section 8.1.3.
+  #
+  # The BER length will either be a single byte or up to 126 bytes in
+  # length. There is a special case of a BER length indicating that the
+  # content-length is undefined and will be identified by the presence of
+  # two null values (0x00 0x00).
+  #
+  # <table>
+  # <tr>
+  # <th>Range</th>
+  # <th>Length</th>
+  # </tr>
+  # <tr>
+  # <th>0x00 -- 0x7f<br />0b00000000 -- 0b01111111</th>
+  # <td>0 - 127 bytes</td>
+  # </tr>
+  # <tr>
+  # <th>0x80<br />0b10000000</th>
+  # <td>Indeterminate (end-of-content marker required)</td>
+  # </tr>
+  # <tr>
+  # <th>0x81 -- 0xfe<br />0b10000001 -- 0b11111110</th>
+  # <td>1 - 126 bytes of length as an integer value</td>
+  # </tr>
+  # <tr>
+  # <th>0xff<br />0b11111111</th>
+  # <td>Illegal (reserved for future expansion)</td>
+  # </tr>
+  # </table>
+  #
+  #--
+  # This has been modified from the version that was previously inside
+  # #read_ber to handle both the indeterminate terminator case and the
+  # invalid BER length case. Because the "lengthlength" value was not used
+  # inside of #read_ber, we no longer return it.
+  def read_ber_length
+    n = getbyte
+
+    if n <= 0x7f
+      n
+    elsif n == 0x80
+      -1
+    elsif n == 0xff
+      raise Net::BER::BerError, "Invalid BER length 0xFF detected."
+    else
+      v = 0
+      read(n & 0x7f).each_byte do |b|
+        v = (v << 8) + b
+      end
+
+      v
+    end
+  end
+  private :read_ber_length
+
+  ##
+  # Reads a BER object from the including object. Requires that #getbyte is
+  # implemented on the including object and that it returns a Fixnum value.
+  # Also requires #read(bytes) to work.
+  #
+  # This does not work with non-blocking I/O.
+  def read_ber(syntax = nil)
+    # TODO: clean this up so it works properly with partial packets coming
+    # from streams that don't block when we ask for more data (like
+    # StringIOs). At it is, this can throw TypeErrors and other nasties.
+
+    id = getbyte or return nil  # don't trash this value, we'll use it later
+    content_length = read_ber_length
+
+    if -1 == content_length
+      raise Net::BER::BerError, "Indeterminite BER content length not implemented."
+    else
+      data = read(content_length)
+    end
+
+    parse_ber_object(syntax, id, data)
+  end
+end

data/lib/net/ber/core_ext/array.rb

@@ -0,0 +1,79 @@
+module Net::BER::Extensions::Array
+  ##
+  # Converts an Array to a BER sequence. All values in the Array are
+  # expected to be in BER format prior to calling this method.
+  def to_ber(id = 0)
+    # The universal sequence tag 0x30 is composed of the base tag value
+    # (0x10) and the constructed flag (0x20).
+    to_ber_seq_internal(0x30 + id)
+  end
+  alias_method :to_ber_sequence, :to_ber
+
+  ##
+  # Converts an Array to a BER set. All values in the Array are expected to
+  # be in BER format prior to calling this method.
+  def to_ber_set(id = 0)
+    # The universal set tag 0x31 is composed of the base tag value (0x11)
+    # and the constructed flag (0x20).
+    to_ber_seq_internal(0x31 + id)
+  end
+
+  ##
+  # Converts an Array to an application-specific sequence, assigned a tag
+  # value that is meaningful to the particular protocol being used. All
+  # values in the Array are expected to be in BER format pr prior to calling
+  # this method.
+  #--
+  # Implementor's note 20100320(AZ): RFC 4511 (the LDAPv3 protocol) as well
+  # as earlier RFCs 1777 and 2559 seem to indicate that LDAP only has
+  # application constructed sequences (0x60). However, ldapsearch sends some
+  # context-specific constructed sequences (0xA0); other clients may do the
+  # same. This behaviour appears to violate the RFCs. In real-world
+  # practice, we may need to change calls of #to_ber_appsequence to
+  # #to_ber_contextspecific for full LDAP server compatibility.
+  #
+  # This note probably belongs elsewhere.
+  #++
+  def to_ber_appsequence(id = 0)
+    # The application sequence tag always starts from the application flag
+    # (0x40) and the constructed flag (0x20).
+    to_ber_seq_internal(0x60 + id)
+  end
+
+  ##
+  # Converts an Array to a context-specific sequence, assigned a tag value
+  # that is meaningful to the particular context of the particular protocol
+  # being used. All values in the Array are expected to be in BER format
+  # prior to calling this method.
+  def to_ber_contextspecific(id = 0)
+    # The application sequence tag always starts from the context flag
+    # (0x80) and the constructed flag (0x20).
+    to_ber_seq_internal(0xa0 + id)
+  end
+
+  ##
+  # The internal sequence packing routine. All values in the Array are
+  # expected to be in BER format prior to calling this method.
+  def to_ber_seq_internal(code)
+    s = self.join
+    [code].pack('C') + s.length.to_ber_length_encoding + s
+  end
+  private :to_ber_seq_internal
+
+  ##
+  # SNMP Object Identifiers (OID) are special arrays
+  #--
+  # 20100320 AZ: I do not think that this method should be in BER, since
+  # this appears to be SNMP-specific. This should probably be subsumed by a
+  # proper SNMP OID object.
+  #++
+  def to_ber_oid
+    ary = self.dup
+    first = ary.shift
+    raise Net::BER::BerError, "Invalid OID" unless [0, 1, 2].include?(first)
+    first = first * 40 + ary.shift
+    ary.unshift first
+    oid = ary.pack("w*")
+    [6, oid.length].pack("CC") + oid
+  end
+end

data/lib/net/ber/core_ext/bignum.rb

@@ -0,0 +1,19 @@
+module Net::BER::Extensions::Bignum
+  ##
+  # Converts a Bignum to an uncompressed BER integer.
+  def to_ber
+    result = []
+
+    # NOTE: Array#pack's 'w' is a BER _compressed_ integer. We need
+    # uncompressed BER integers, so we're not using that. See also:
+    # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/228864
+    n = self
+    while n > 0
+      b = n & 0xff
+      result << b
+      n = n >> 8
+    end
+
+    "\002" + ([result.size] + result.reverse).pack('C*')
+  end
+end

data/lib/net/ber/core_ext/false_class.rb

@@ -0,0 +1,7 @@
+module Net::BER::Extensions::FalseClass
+  ##
+  # Converts +false+ to the BER wireline representation of +false+.
+  def to_ber
+    "\001\001\000"
+  end
+end

data/lib/net/ber/core_ext/fixnum.rb

@@ -0,0 +1,63 @@
+module Net::BER::Extensions::Fixnum
+  ##
+  # Converts the fixnum to BER format.
+  def to_ber
+    "\002#{to_ber_internal}"
+  end
+
+  ##
+  # Converts the fixnum to BER enumerated format.
+  def to_ber_enumerated
+    "\012#{to_ber_internal}"
+  end
+
+  ##
+  # Converts the fixnum to BER length encodining format.
+  def to_ber_length_encoding
+    if self <= 127
+      [self].pack('C')
+    else
+      i = [self].pack('N').sub(/^[\0]+/,"")
+      [0x80 + i.length].pack('C') + i
+    end
+  end
+
+  ##
+  # Generate a BER-encoding for an application-defined INTEGER. Examples of
+  # such integers are SNMP's Counter, Gauge, and TimeTick types.
+  def to_ber_application(tag)
+    [0x40 + tag].pack("C") + to_ber_internal
+  end
+
+  ##
+  # Used to BER-encode the length and content bytes of a Fixnum. Callers
+  # must prepend the tag byte for the contained value.
+  def to_ber_internal
+    # CAUTION: Bit twiddling ahead. You might want to shield your eyes or
+    # something.
+
+    # Looks for the first byte in the fixnum that is not all zeroes. It does
+    # this by masking one byte after another, checking the result for bits
+    # that are left on.
+    size = Net::BER::MAX_FIXNUM_SIZE
+    while size > 1
+      break if (self & (0xff << (size - 1) * 8)) > 0
+      size -= 1
+    end
+
+    # Store the size of the fixnum in the result
+    result = [size]
+
+    # Appends bytes to result, starting with higher orders first. Extraction
+    # of bytes is done by right shifting the original fixnum by an amount
+    # and then masking that with 0xff.
+    while size > 0
+      # right shift size - 1 bytes, mask with 0xff
+      result << ((self >> ((size - 1) * 8)) & 0xff)
+      size -= 1
+    end
+
+    result.pack('C*')
+  end
+  private :to_ber_internal
+end

data/lib/net/ber/core_ext/string.rb

@@ -0,0 +1,45 @@
+require 'stringio'
+
+module Net::BER::Extensions::String
+  ##
+  # Converts a string to a BER string. Universal octet-strings are tagged
+  # with 0x04, but other values are possible depending on the context, so we
+  # let the caller give us one.
+  #
+  # User code should call either #to_ber_application_string or
+  # #to_ber_contextspecific.
+  def to_ber(code = 0x04)
+    [code].pack('C') + length.to_ber_length_encoding + self
+  end
+
+  ##
+  # Creates an application-specific BER string encoded value with the
+  # provided syntax code value.
+  def to_ber_application_string(code)
+    to_ber(0x40 + code)
+  end
+
+  ##
+  # Creates a context-specific BER string encoded value with the provided
+  # syntax code value.
+  def to_ber_contextspecific(code)
+    to_ber(0x80 + code)
+  end
+
+  ##
+  # Nondestructively reads a BER object from this string.
+  def read_ber(syntax = nil)
+    StringIO.new(self).read_ber(syntax)
+  end
+  
+  ##
+  # Destructively reads a BER object from the string. 
+  def read_ber!(syntax = nil)
+    io = StringIO.new(self)
+
+    result = io.read_ber(syntax)
+    self.slice!(0...io.pos)
+    
+    return result
+  end
+end

data/lib/net/ber/core_ext/true_class.rb

@@ -0,0 +1,9 @@
+module Net::BER::Extensions::TrueClass
+  ##
+  # Converts +true+ to the BER wireline representation of +true+.
+  def to_ber
+    # 20100319 AZ: Note that this may not be the completely correct value,
+    # per some test documentation. We need to determine the truth of this.
+    "\001\001\001"
+  end
+end

data/lib/net/ber/core_ext.rb

@@ -0,0 +1,72 @@
+# NET::BER
+# Mixes ASN.1/BER convenience methods into several standard classes. Also
+# provides BER parsing functionality.
+#
+#--
+# Copyright (C) 2006 by Francis Cianfrocca and other contributors. 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
+#++
+
+require 'net/ber/ber_parser'
+class IO
+  include Net::BER::BERParser
+end
+
+class StringIO
+  include Net::BER::BERParser
+end
+
+if defined? ::OpenSSL
+  class OpenSSL::SSL::SSLSocket
+    include Net::BER::BERParser
+  end
+end
+
+module Net::BER::Extensions; end
+
+require 'net/ber/core_ext/string'
+class String
+  include Net::BER::BERParser
+  include Net::BER::Extensions::String
+end
+
+require 'net/ber/core_ext/array'
+class Array
+  include Net::BER::Extensions::Array
+end
+
+require 'net/ber/core_ext/bignum'
+class Bignum
+  include Net::BER::Extensions::Bignum
+end
+
+require 'net/ber/core_ext/fixnum'
+class Fixnum
+  include Net::BER::Extensions::Fixnum
+end
+
+require 'net/ber/core_ext/true_class'
+class TrueClass
+  include Net::BER::Extensions::TrueClass
+end
+
+require 'net/ber/core_ext/false_class'
+class FalseClass
+  include Net::BER::Extensions::FalseClass
+end