dnet-ffi 0.1.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+ref
+mirror

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Eric Monti
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,37 @@
+= dnet-ffi
+
+Ruby FFI bindings for libdnet.
+
+== REQUIREMENTS
+
+* libdnet up to v1.12 - see http://libdnet.sourceforge.net or 
+  http://code.google.com/p/libdnet 
+
+* Ruby ffi  >= 0.5.0 - see http://github.com/ffi/ffi or http://rubyforge.org/projects/ffi/ 
+
+* ffi_dry - see http://github.com/emonti/ffi_dry
+
+
+== LICENSE
+
+Copyright (c) 2009 Eric Monti
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+require 'rake/clean'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dnet-ffi"
+    gem.summary = %Q{Ruby FFI bindings for libdnet}
+    gem.description = %Q{Ruby FFI bindings for the libdnet raw network library}
+    gem.email = "emonti@matasano.com"
+    gem.homepage = "http://github.com/emonti/dnet-ffi"
+    gem.authors = ["Eric Monti"]
+    gem.files.delete_if {|f| f =~ /^mirror\//}
+#    gem.add_dependency "emonti-ffi_dry"
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ['--colour', '--format', 'nested']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+require 'rake/rdoctask' 
+Rake::RDocTask.new do |rdoc| 
+  if File.exist?('VERSION') 
+    version = File.read('VERSION') 
+  else 
+    version = "" 
+  end 
+ 
+  rdoc.rdoc_dir = 'rdoc' 
+  rdoc.title = "dnet-ffi #{version}" 
+  rdoc.rdoc_files.include('README*') 
+  rdoc.rdoc_files.include('lib/**/*.rb') 
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/dnet-ffi.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dnet-ffi}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Monti"]
+  s.date = %q{2009-09-17}
+  s.description = %q{Ruby FFI bindings for the libdnet raw network library}
+  s.email = %q{emonti@matasano.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dnet-ffi.gemspec",
+     "lib/dnet.rb",
+     "lib/dnet/addr.rb",
+     "lib/dnet/arp.rb",
+     "lib/dnet/blob.rb",
+     "lib/dnet/bsd.rb",
+     "lib/dnet/constants.rb",
+     "lib/dnet/eth.rb",
+     "lib/dnet/fw.rb",
+     "lib/dnet/helpers.rb",
+     "lib/dnet/icmp.rb",
+     "lib/dnet/intf.rb",
+     "lib/dnet/ip.rb",
+     "lib/dnet/ip6.rb",
+     "lib/dnet/rand.rb",
+     "lib/dnet/route.rb",
+     "lib/dnet/tcp.rb",
+     "lib/dnet/tun.rb",
+     "lib/dnet/typedefs.rb",
+     "lib/dnet/udp.rb",
+     "lib/dnet/util.rb",
+     "samples/eth_send_raw.rb",
+     "samples/ifconfig-alike.rb",
+     "samples/udp_send_raw.rb",
+     "spec/addr_spec.rb",
+     "spec/arp_spec.rb",
+     "spec/blob_spec.rb",
+     "spec/bsd_spec.rb",
+     "spec/dnet-ffi_spec.rb",
+     "spec/eth_spec.rb",
+     "spec/fw_spec.rb",
+     "spec/intf_spec.rb",
+     "spec/ip6_spec.rb",
+     "spec/ip_spec.rb",
+     "spec/rand_spec.rb",
+     "spec/route_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/tun_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/emonti/dnet-ffi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Ruby FFI bindings for libdnet}
+  s.test_files = [
+    "spec/addr_spec.rb",
+     "spec/arp_spec.rb",
+     "spec/blob_spec.rb",
+     "spec/bsd_spec.rb",
+     "spec/dnet-ffi_spec.rb",
+     "spec/eth_spec.rb",
+     "spec/fw_spec.rb",
+     "spec/intf_spec.rb",
+     "spec/ip6_spec.rb",
+     "spec/ip_spec.rb",
+     "spec/rand_spec.rb",
+     "spec/route_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/tun_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/dnet.rb

@@ -0,0 +1,35 @@
+begin
+  require 'rubygems'
+rescue LoadError
+end
+require 'ffi'
+require 'ffi/dry'
+
+module Dnet
+  extend FFI::Library
+  ffi_lib 'libdnet'
+end
+
+require 'dnet/typedefs.rb'
+require 'dnet/constants.rb' unless defined?(Dnet::DNET_CONSTANTS)
+
+require 'dnet/util.rb'
+require 'dnet/helpers.rb'
+
+require 'dnet/bsd' # bsd sockaddr structs
+
+require 'dnet/addr'
+require 'dnet/eth'
+require 'dnet/arp'
+require 'dnet/ip'
+require 'dnet/ip6'
+require 'dnet/icmp'
+require 'dnet/tcp.rb'
+require 'dnet/udp.rb'
+require 'dnet/intf'
+require 'dnet/route'
+require 'dnet/fw'
+require 'dnet/tun'
+require 'dnet/blob'
+require 'dnet/rand'
+

data/lib/dnet/addr.rb

@@ -0,0 +1,204 @@
+# Network addressing
+
+module Dnet
+
+  # FFI mapping to dnet(3)'s 'addr' network address structure.
+  #
+  # dnet(3)'s network addresses are described by the following C structure:
+  #
+  #    struct addr {
+  #            uint16_t                atype;
+  #            uint16_t                abits;
+  #            union {
+  #                    eth_addr_t      __eth;
+  #                    ip_addr_t       __ip;
+  #                    ip6_addr_t      __ip6;
+  #
+  #                    uint8_t         __data8[16];
+  #                    uint16_t        __data16[8];
+  #                    uint32_t        __data32[4];
+  #            } __addr_u;
+  #    };
+  #
+  class Addr < ::FFI::Struct
+    include ::FFI::DRY::StructHelper
+
+    # A mapping of dnet address types
+    ADDR_TYPES = [ nil, :link, :inet, :inet6 ] 
+
+    # struct addr { ... };
+    dsl_layout do
+      field :atype, :uint16
+      field :bits,  :uint16
+      array :addr,  [:uchar, 16]
+    end
+
+    # If passed a String argument (and only 1 arg), it will be parsed as 
+    # an address using set_string(). 
+    #
+    # The fields :bits and :addr aren't allowed to be used together.
+    # Instead, just use :addr => 'n.n.n.n/bits'. See also set_string()
+    def initialize(*args)
+      if args.size == 1 and (str=args[0]).is_a? String
+        super()
+        self.aton(str)
+      else
+        super(*args)
+      end
+    end
+
+    # Overrides set_fields to reject :bits fields when :addr is supplied as 
+    # well.
+    #
+    # Forces you to use :addr => 'x.x.x.x/nn' instead. Having both together
+    # leaves setting :bits up to chance depending on which hash key gets
+    # plucked first in set_fields() because of how ip_aton() works under 
+    # the hood.
+    def set_fields(params=nil)
+      params ||= {}
+      if params[:bits] and params[:addr]
+        raise( ::ArgumentError, 
+           "Don't use :addr and :bits fields together. "+
+           "Just use :addr => 'x.x.x.x/nn' where nn are the bits." )
+      else
+        super(params)
+      end
+    end
+
+    # Looks up this object's 'atype' member against ADDR_TYPES
+    # Returns a symbol for the type or nil a type is not found.
+    def addr_type; ADDR_TYPES[ self[:atype] ] ; end
+    alias lookup_atype addr_type
+
+    # Returns a human-readable network address from self. Uses dnet(3)'s
+    # addr_ntoa function under the hood.
+    def ntoa
+      Dnet.addr_ntoa(self)
+    end
+    alias string ntoa
+    alias addr ntoa
+
+    # Returns a new Addr object containing the broadcast address for the
+    # network specified in this object. Uses dnet(3)'s addr_bcast under the
+    # hood.
+    def bcast
+      bcast = self.class.new()
+      Dnet.addr_bcast(self, bcast)
+      return bcast
+    end
+    alias broadcast bcast
+
+    # Returns a new Addr object containing the network address for the 
+    # network specified in this object. Uses dnet(3)'s addr_net under the
+    # hood.
+    def net
+      n = self.class.new()
+      Dnet.addr_net(self, n)
+      return n
+    end
+    alias network net
+
+    # Compare one Addr object against another. Uses dnet(3)'s addr_cmp 
+    # under the hood.
+    #
+    # addr_cmp() compares network addresses a and b, returning an integer less
+    # than, equal to, or greater than zero if a is found, respectively, to be
+    # less than, equal to, or greater than b.  Both addresses must be of the
+    # same address type.
+    def <=>(other)
+      raise "can only compare another #{self.class}" unless other.is_a? Addr
+      Dnet.addr_cmp(self, other)
+    end
+
+    # Converts an address (or hostname) from a string to network format 
+    # storing the result in this object. Uses dnet(3)'s addr_pton under 
+    # the hood.
+    def set_string(str)
+      return self if Dnet.addr_pton(str, self) == 0
+    end
+    alias aton set_string
+    alias pton set_string
+    alias from_string set_string
+    alias addr= set_string
+
+    # Convert an address from network format to a string and store the 
+    # result in a destination buffer.  This uses dnet(3)'s addr_ntop under 
+    # the hood.
+    def ntop(buf_p, sz)
+      Dnet.addr_ntop(self, buf_p, sz)
+    end
+
+    # Returns a new Addr object from a string address. Hostnames work too.
+    def self.from_string(str)
+      new().set_string(str)
+    end
+
+    # Returns a new Addr object containing the broadcast address for the
+    # given string address.
+    def self.bcast(str)
+      return nil unless b=from_string(str)
+      b.bcast
+    end
+
+    # Returns a new Addr object containing the broadcast address for the
+    # given string address.
+    def self.net(str)
+      return nil unless n=from_string(str)
+      n.net
+    end
+  end
+
+  attach_function :addr_cmp,    [Addr, Addr], :int
+  attach_function :addr_bcast,  [Addr, Addr], :int
+  attach_function :addr_net,    [Addr, Addr], :int
+  attach_function :addr_ntop,   [Addr, :pointer, :size_t], :string
+  attach_function :addr_ntoa,   [Addr], :string
+  attach_function :addr_pton,   [:string, Addr], :int
+
+  # addr_aton is just an alias for addr_pton. eh, it's in the manpage...
+  class <<self ; alias_method :addr_aton, :addr_pton; end
+
+  ### Misc unused stuff from dnet(3):
+
+  # addr_ntos converts an address from network format to the appropriate
+  # struct sockaddr.
+  #
+  #   int addr_ntos(const struct addr *a, struct sockaddr *sa);
+  #
+  attach_function :addr_ntos, [:pointer, :pointer], :int
+
+  # addr_ston converts an address from a struct sockaddr to network format.
+  #
+  #   int addr_ston(const struct sockaddr *sa, struct addr *a);
+  #
+  attach_function :addr_ston, [:pointer, :pointer], :int
+
+  # addr_btos converts a network mask length to a network mask specified as
+  # a struct sockaddr.
+  #
+  #   int addr_btos(uint16_t bits, struct sockaddr *sa);
+  #
+  attach_function :addr_btos, [:uint16, :pointer], :int
+
+  # addr_stob converts a network mask specified in a struct sockaddr to a
+  # network mask length.
+  #
+  #   int addr_stob(const struct sockaddr *sa, uint16_t *bits);
+  #
+  attach_function :addr_stob, [:pointer, :pointer], :int
+
+  # addr_btom converts a network mask length to a network mask in network
+  # byte order.
+  #
+  #   int addr_btom(uint16_t bits, void *mask, size_t size);
+  attach_function :addr_btom, [:uint16, :pointer, :size_t], :int
+
+  # addr_mtob converts a network mask in network byte order to a network
+  # mask length.
+  #
+  #   int addr_mtob(const void *mask, size_t size, uint16_t *bits);
+  #
+  attach_function :addr_mtob, [:pointer, :size_t, :uint16], :int
+
+end
+