ethernet 0.1.1 → 0.1.2

data/Gemfile

@@ -3,8 +3,7 @@ source 'http://rubygems.org'
 # Example:
 #   gem 'activesupport', '>= 2.3.5'
 
-gem 'system-getifaddrs', '~> 0.1.1', :platform => :ruby,
-    :require => 'system/getifaddrs'
+gem 'ffi', '>= 1.0.0', :platform => :mri
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -13,5 +12,5 @@ group :development do
   gem 'rspec', '~> 2.6.0'
   gem 'bundler', '~> 1.0.0'
   gem 'jeweler', '~> 1.6.0'
-  gem 'rcov', '>= 0'
+  gem 'rcov', '>= 0', :platform => :mri
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
+    ffi (1.0.9)
     git (1.2.5)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
@@ -18,15 +19,15 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    system-getifaddrs (0.1.1)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  ffi (>= 1.0.0)
   jeweler (~> 1.6.0)
   rcov
   rdoc (>= 3.6.1)
   rspec (~> 2.6.0)
-  system-getifaddrs (~> 0.1.1)

data/README.rdoc

@@ -4,6 +4,14 @@ A Ruby Gem Library for Ethernet Communication
 
 This project is a low-level ethernet communication rubygems library. Its initial intension is to set up a communication API between the FPGA chip and the server for MIT's Trusted Computing Secure Storage project http://projects.csail.mit.edu/tc/. 
 
+== Supported Platforms
+
+ethernet currently works on Linux and Mac OSX. It should work on other OSes that have kernel support for BPF (Berkely Packet Filter), with minor hacking.
+
+ethernet does not currently work on Windows, and is unlikely to do so in the near future. Microsoft, in its infinite wisdom, decided to remove low-level Ethernet support from Windows starting from XP SP2, so the gem would have to ship a pre-compiled miniport driver. Patches are welcome!
+
+ethernet is tested on MRI, but should run on all Ruby VMs that have FFI support, including JRuby and Rubinius. Please file bugs if that is not the case.
+
 == Contributing to ethernet
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -14,7 +22,7 @@ This project is a low-level ethernet communication rubygems library. Its initial
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Author
+== Authors
 
 Victor Costan victor@costan.us
 HaoQi Li haoqili@mit.edu

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/ethernet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ethernet}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Victor Costan}, %q{HaoQi Li}]
-  s.date = %q{2011-05-27}
+  s.date = %q{2011-05-30}
   s.description = %q{Provides a Socket-like API that bypasses TCP/IP. Useful for exotic devices and FPGA development.}
   s.email = %q{victor@costan.us}
   s.extra_rdoc_files = [
@@ -29,9 +29,13 @@ Gem::Specification.new do |s|
     "ethernet.gemspec",
     "lib/ethernet.rb",
     "lib/ethernet/devices.rb",
+    "lib/ethernet/devices_darwin.rb",
+    "lib/ethernet/devices_linux.rb",
     "lib/ethernet/frame_socket.rb",
     "lib/ethernet/provisioning.rb",
     "lib/ethernet/raw_socket_factory.rb",
+    "lib/ethernet/raw_socket_factory_darwin.rb",
+    "lib/ethernet/raw_socket_factory_linux.rb",
     "spec/ethernet/devices_spec.rb",
     "spec/ethernet/frame_socket_spec.rb",
     "spec/ethernet/raw_socket_factory_spec.rb",
@@ -50,14 +54,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<system-getifaddrs>, ["~> 0.1.1"])
+      s.add_runtime_dependency(%q<ffi>, [">= 1.0.0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.6.1"])
       s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<system-getifaddrs>, ["~> 0.1.1"])
+      s.add_dependency(%q<ffi>, [">= 1.0.0"])
       s.add_dependency(%q<rdoc>, [">= 3.6.1"])
       s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -65,7 +69,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<system-getifaddrs>, ["~> 0.1.1"])
+    s.add_dependency(%q<ffi>, [">= 1.0.0"])
     s.add_dependency(%q<rdoc>, [">= 3.6.1"])
     s.add_dependency(%q<rspec>, ["~> 2.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/ethernet.rb

@@ -42,3 +42,11 @@ require 'ethernet/devices.rb'
 require 'ethernet/frame_socket.rb'
 require 'ethernet/provisioning.rb'
 require 'ethernet/raw_socket_factory.rb'
+case Ethernet::Provisioning::OS
+when /darwin/
+  require 'ethernet/devices_darwin.rb'
+  require 'ethernet/raw_socket_factory_darwin.rb'
+when /linux/
+  require 'ethernet/devices_linux.rb'
+  require 'ethernet/raw_socket_factory_linux.rb'
+end

data/lib/ethernet/devices.rb

@@ -1,23 +1,13 @@
-# OS-dependent gem includes.
-case RUBY_PLATFORM
-when /linux/
-when /darwin/
-  require 'system/getifaddrs'
-end
+require 'ffi'
 
 # :nodoc: namespace
 module Ethernet
 
 # Information about the available Ethernet devices.
 module Devices
-  # An array of device names for the machine's Ethernet devices.
+  # Array containing device names.
   def self.all
-    case RUBY_PLATFORM
-    when /linux/, /darwin/
-      System.get_ifaddrs.keys.map(&:to_s)
-    else
-      raise "Unsupported platform #{RUBY_PLATFORM}"
-    end
+    info.keys
   end
   
   # The MAC address for an Ethernet device.
@@ -25,16 +15,91 @@ module Devices
   # Args:
   #   eth_device:: device name for the Ethernet card, e.g. 'eth0'
   def self.mac(eth_device)
-    case RUBY_PLATFORM
-    when /linux/
-      # /usr/include/net/if.h, structure ifreq
-      ifreq = [eth_device].pack 'a32'
-      # 0x8927 is SIOCGIFHWADDR in /usr/include/bits/ioctls.h
-      RawSocketFactory.socket.ioctl 0x8927, ifreq
-      ifreq[18, 6]
-    else
-      raise "Unsupported platform #{RUBY_PLATFORM}"
+    info[eth_device][:mac]
+  end
+  
+  # The interface number for an Ethernet interface.
+  #
+  # Args:
+  #   eth_device:: device name for the Ethernet card, e.g. 'eth0'
+  def self.interface_index(eth_device)
+    info[eth_device][:index]
+  end
+  
+  # Hash mapping device names to information about devices.
+  def self.info
+    # array of struct ifreq in /usr/include/net/if.h
+    buffer_size = ifreq_size * 128
+    buffer_ptr = FFI::MemoryPointer.new :uchar, buffer_size, 0
+    # struct ifconf in /usr/include/net/if.h
+    ifconf = [buffer_size, buffer_ptr.address].pack ifconf_packspec
+    ioctl_socket.ioctl siocgifconf_ioctl, ifconf
+    
+    output_size = ifconf.unpack('l').first
+    offset = 0
+    devices = {}
+    while offset < output_size
+      name = (buffer_ptr + offset).read_string_to_null
+      devices[name] ||= {}
+      # struct sockaddr
+      addr_length, addr_family = *(buffer_ptr + offset + 16).read_string(2).
+                                                             unpack('CC')
+      addr_length = ifreq_size - 16 if addr_length < ifreq_size - 16
+      if addr_family == ll_address_family
+        # struct sockaddr_dl in /usr/include/net/if_dl.h
+        devices[name][:index], blah, skip, length =
+            *(buffer_ptr + offset + 18).read_string(4).unpack('SCCC')
+        devices[name][:mac] =
+            (buffer_ptr + offset + 24 + skip).read_string(length)
+      end
+      
+      offset += 16 + addr_length
+    end
+    
+    if devices.all? { |k, v| v[:mac].nil? }
+      # Linux only provides IP addresses in SIOCGIFCONF.
+      devices.keys.each do |device|
+        devices[device][:mac] ||= mac device
+        devices[device][:index] ||= interface_index device
+      end
+    end
+    devices.delete_if { |k, v| v[:mac].nil? || v[:mac].empty? }
+    
+    devices
+  end
+  
+  class <<self
+    # SIOCGIFCONF ioctl number.
+    def siocgifconf_ioctl
+      raise "Unsupported os #{Ethernet::Provisioning::OS}"
+    end
+    
+    
+    # Array#pack specification for struct ifconf.
+    #
+    # The specification converts a [size, pointer] array into a valid struct.
+    def ifconf_packspec
+      raise "Unsupported os #{Ethernet::Provisioning::OS}"
+    end
+    private :ifconf_packspec
+    
+    # Size of a struct ifreq.
+    def ifreq_size
+      raise "Unsupported os #{Ethernet::Provisioning::OS}"
+    end
+    private :ifreq_size
+    
+    # The link layer address number for raw sockets. 
+    def ll_address_family
+      raise "Unsupported os #{Ethernet::Provisioning::OS}"
+    end
+    private :ll_address_family
+  
+    # Socket that is solely used for issuing ioctls.
+    def ioctl_socket
+      Socket.new(Socket::AF_INET, Socket::SOCK_DGRAM, 0)
     end
+    private :ioctl_socket
   end
 end  # class Ethernet::Devices
 

data/lib/ethernet/devices_darwin.rb

@@ -0,0 +1,31 @@
+# :nodoc: namespace
+module Ethernet
+
+# :nodoc: darwin-specific implementation
+module Devices
+  # :nodoc: darwin implementation
+  def self.ll_address_family
+    18  # cat /usr/include/sys/socket.h | grep AF_PACKET
+  end
+
+  # :nodoc: darwin implementation
+  def self.siocgifconf_ioctl
+    # SIOCGIFCONF in /usr/include/sys/sockio.h
+    # _IOW in /usr/include/sys/ioccom.h
+    0xc00c6924
+  end
+  
+  # :nodoc: darwin implementation
+  def self.ifconf_packspec
+    # struct ifconf in /usr/include/net/if.h
+    Ethernet::Provisioning::POINTER_SIZE == 8 ? 'LQ' : 'LL'
+  end
+
+  # :nodoc: darwin implementation
+  def self.ifreq_size
+    # struct ifreq in /usr/include/net/if.h
+    32
+  end
+end  # class Ethernet::Devices
+
+end  # namespace Ethernet

data/lib/ethernet/devices_linux.rb

@@ -0,0 +1,48 @@
+# :nodoc: namespace
+module Ethernet
+
+# :nodoc: linux-specific implementation
+module Devices
+  # :nodoc: linux implementation
+  def self.mac(eth_device)
+    # structure ifreq in /usr/include/net/if.h
+    ifreq = [eth_device].pack 'a32'
+    # 0x8927 is SIOCGIFHWADDR in /usr/include/bits/ioctls.h
+    ioctl_socket.ioctl 0x8927, ifreq
+    ifreq[18, 6]
+  end
+  
+  # :nodoc: linux implementation
+  def self.interface_index(eth_device)
+    # /usr/include/net/if.h, structure ifreq
+    ifreq = [eth_device].pack 'a32'
+    # 0x8933 is SIOCGIFINDEX in /usr/include/bits/ioctls.h
+    ioctl_socket.ioctl 0x8933, ifreq
+    ifreq[16, 4].unpack('I').first
+  end
+
+  # :nodoc: linux-specific implementation
+  def self.ll_address_family
+    17  # cat /usr/include/bits/socket.h | grep PF_PACKET
+  end
+
+  # :nodoc: linux-specific implementation
+  def self.siocgifconf_ioctl
+    # SIOCGIFCONF in /usr/include/bits/ioctls.h
+    0x8912
+  end
+
+  # :nodoc: linux-specific implementation
+  def self.ifconf_packspec
+    # struct ifconf in /usr/include/net/if.h
+    Ethernet::Provisioning::POINTER_SIZE == 8 ? 'QQ' : 'LL'
+  end
+  
+  # :nodoc: linux-specific implementation
+  def self.ifreq_size
+    # struct ifreq in /usr/include/net/if.h
+    Ethernet::Provisioning::POINTER_SIZE == 8 ? 40 : 32
+  end
+end  # class Ethernet::Devices
+
+end  # namespace Ethernet

data/lib/ethernet/frame_socket.rb

@@ -85,7 +85,7 @@ class FrameSocket
   #
   # This will discard incoming frames that don't match the MAC address that the
   # socket is connected to, or the Ethernet packet type.
-  def recv(buffer_size = 8192)
+  def recv(buffer_size = 4096)
     raise "Not connected" unless @dest_mac
     loop do
       data, mac_address = recv_from buffer_size
@@ -103,11 +103,12 @@ class FrameSocket
   #
   # This will discard incoming frames that don't match the MAC address that the
   # socket is connected to, or the Ethernet packet type.
-  def recv_from(buffer_size = 8192)
+  def recv_from(buffer_size = 4096)
     loop do
       packet = @socket.recv buffer_size
       next unless packet[12, 2] == @ether_type
-      next unless packet[0, 6] == @source_mac
+      # The last part of the condition accepts multicast packets.
+      next if packet[0, 6] != @source_mac && packet.unpack('C').first & 1 == 0
       return packet[14..-1], packet[6, 6]
     end
   end

data/lib/ethernet/provisioning.rb

@@ -6,6 +6,12 @@ module Ethernet
 
 # Setup issues such as assigning permissions for Ethernet-level transmission.
 module Provisioning
+  # The kernel that the VM is running on (e.g. "darwin", "linux")
+  OS = Config::CONFIG['target_os']
+  
+  # Number of bytes taken by a pointer on the Machine.
+  POINTER_SIZE = 1.size
+  
   # Allow non-root users to create low-level Ethernet sockets.
   #
   # This is a security risk, because Ethernet sockets can be used to spy on all
@@ -15,13 +21,13 @@ module Provisioning
   # Returns true for success, false otherwise. If the call fails, it is most
   # likely because it is not run by root / Administrator.
   def self.usermode_sockets
-    case RUBY_PLATFORM
+    case OS
     when /darwin/
-      return false unless Kernel.system("chmod o+r /dev/bpf*")
+      return false unless Kernel.system("sudo chmod o+rw /dev/bpf*")
     when /linux/
       ruby = File.join Config::CONFIG['bindir'],
                        Config::CONFIG['ruby_install_name']
-      unless Kernel.system("setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' #{ruby}")
+      unless Kernel.system("sudo setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' #{ruby}")
         return false
       end
       
@@ -29,13 +35,13 @@ module Provisioning
       # No big deal if this fails.
       dumpcap = '/usr/bin/dumpcap'
       if File.exist? dumpcap
-        Kernel.system("setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' #{dumpcap}")
+        Kernel.system("sudo setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' #{dumpcap}")
       end
     when /win/
       # NOTE: this might not work
       return false unless Kernel.system("sc config npf start= auto")
     else
-      raise "Unsupported platform #{RUBY_PLATFORM}"
+      raise "Unsupported os #{Ethernet::Provisioning.platform}"
     end
     true
   end

data/lib/ethernet/raw_socket_factory.rb

@@ -1,10 +1,5 @@
 require 'socket'
 
-case RUBY_PLATFORM
-when /linux/
-  require 'system/getifaddrs' # for listing
-end
-
 # :nodoc: namespace
 module Ethernet
 
@@ -15,77 +10,24 @@ module RawSocketFactory
   # Args:
   #   eth_device:: device name for the Ethernet card, e.g. 'eth0'
   #   ether_type:: only receive Ethernet frames with this protocol number
-  def self.socket(eth_device = nil, ether_type = nil)
-    ether_type ||= all_ethernet_protocols
-    socket = Socket.new raw_address_family, Socket::SOCK_RAW, htons(ether_type)
-    socket.setsockopt Socket::SOL_SOCKET, Socket::SO_BROADCAST, true
-    set_socket_eth_device(socket, eth_device, ether_type) if eth_device
-    socket
+  def self.socket(eth_device, ether_type = nil)
+    # This method is redefined in platform-specific implementations.
+    raise "Unsupported os #{Ethernet::Provisioning::OS}"
   end
-  
+
   class <<self
-    # Sets the Ethernet interface and protocol type for a socket.
-    def set_socket_eth_device(socket, eth_device, ether_type)
-      case RUBY_PLATFORM
-      when /linux/
-        if_number = get_interface_number eth_device
-        # struct sockaddr_ll in /usr/include/linux/if_packet.h
-        socket_address = [raw_address_family, htons(ether_type), if_number,
-                          0xFFFF, 0, 0, ""].pack 'SSISCCa8'
-        socket.bind socket_address
-      else
-        raise "Unsupported platform #{RUBY_PLATFORM}"
-      end
-      socket
-    end
-    private :set_socket_eth_device
-    
-    # The interface number for an Ethernet interface.
-    def get_interface_number(eth_device)
-      case RUBY_PLATFORM
-      when /linux/
-        # /usr/include/net/if.h, structure ifreq
-        ifreq = [eth_device].pack 'a32'
-        # 0x8933 is SIOCGIFINDEX in /usr/include/bits/ioctls.h
-        socket.ioctl 0x8933, ifreq
-        ifreq[16, 4].unpack('I').first
-      else
-        raise "Unsupported platform #{RUBY_PLATFORM}"
-      end
-    end
-    private :get_interface_number
-    
-    # The protocol number for listening to all ethernet protocols.
-    def all_ethernet_protocols
-      case RUBY_PLATFORM
-      when /linux/
-        3  # cat /usr/include/linux/if_ether.h | grep ETH_P_ALL
-      else
-        raise "Unsupported platform #{RUBY_PLATFORM}"
-      end
-    end
-    private :all_ethernet_protocols
-    
-    # The AF / PF number for raw sockets.
-    def raw_address_family
-      case RUBY_PLATFORM
-      when /linux/
-        17  # cat /usr/include/bits/socket.h | grep PF_PACKET
-      when /darwin/
-        18  # cat /usr/include/sys/socket.h | grep AF_LINK
-      else
-        raise "Unsupported platform #{RUBY_PLATFORM}"
-      end
-    end
-    private :raw_address_family
-  
     # Converts a 16-bit integer from host-order to network-order.
     def htons(short_integer)
       [short_integer].pack('n').unpack('S').first
     end
     private :htons
+
+    # Converts a 32-bit integer from host-order to network-order.
+    def htonl(long_integer)
+      [long_integer].pack('N').unpack('L').first
+    end
+    private :htonl
   end
 end  # module Ethernet::RawSocketFactory
 
 end  # namespace Ethernet
-

data/lib/ethernet/raw_socket_factory_darwin.rb

@@ -0,0 +1,177 @@
+require 'socket'
+
+# :nodoc: namespace
+module Ethernet
+
+# Low-level socket creation functionality.
+module RawSocketFactory
+  # A raw socket sends and receives raw Ethernet frames.
+  #
+  # Args:
+  #   eth_device:: device name for the Ethernet card, e.g. 'eth0'
+  #   ether_type:: only receive Ethernet frames with this protocol number
+  def self.socket(eth_device, ether_type = nil)
+    bpf = bpf_pseudo_socket
+    set_bpf_eth_device bpf, eth_device, ether_type
+    Ethernet::RawSocketFactory::BpfSocketWrapper.new bpf
+  end
+  
+  class <<self
+    # Returns a BPF file descriptor that acts almost like a link-layer socket.
+    #
+    # BPF means Berkeley Packet Filter, and works on FreeBSD-like kernels,
+    # including Darwin.
+    def bpf_pseudo_socket
+      3.times do
+        Dir['/dev/bpf*'].sort.each do |name|
+          begin
+            s = File.open name, 'r+b'
+            s.sync = true
+            return s
+          rescue Errno::EBUSY
+            # Move to the next BPF device.
+          end
+        end
+      end
+      return nil
+    end
+    private :bpf_pseudo_socket
+    
+    # Binds a BPF file descriptor to a device and limits packet capture.
+    #
+    # BPF means Berkeley Packet Filter, and works on FreeBSD-like kernels,
+    # including Darwin.
+    #
+    # This method also sets flags so that the socket behaves as much as possible
+    # like a Linux PF_PACKET raw socket.
+    def set_bpf_eth_device(bpf, eth_device, ether_type)
+      # BIOCSETIF in /usr/include/net/bpf.h
+      # _IOW in /usr/include/sys/ioccom.h
+      # struct ifreq in /usr/include/net/if.h
+      bpf.ioctl 0x8020426C, [eth_device].pack('a32')
+      
+      # Receive packets as soon as they're available.
+      # BIOCIMMEDIATE in /usr/include/net/bpf.h
+      # _IOW in /usr/include/sys/ioccom.h
+      bpf.ioctl 0x80044270, [1].pack('L')
+      
+      # Don't automatically set the Ethernet header.
+      # BIOCSHDRCMPLT in /usr/include/net/bpf.h
+      # _IOW in /usr/include/sys/ioccom.h
+      bpf.ioctl 0x80044275, [1].pack('L')
+      
+      # Don't receive the packets that we sent ourselves.
+      # BIOCSSEESENT in /usr/include/net/bpf.h
+      # _IOW in /usr/include/sys/ioccom.h
+      bpf.ioctl 0x80044275, [0].pack('L')
+      
+      # BPF filter programming constants in /usr/include/net/bpf.h
+      if ether_type
+        filter = [
+          # A <- packet Ethernet type
+          [0x28, 0, 0, 12],  # BPF_LD + BPF_H + BPF_ABS
+          # if A == ether_type jump above next instruction
+          [0x15, 1, 0, ether_type],  # BPF_JMP + BPF_JEQ + BPF_K
+          # drop packet (ret K = 0)
+          [0x06, 0, 0, 0]  # BPF_RET + BPF_K
+        ]
+      else
+        filter = []
+      end
+      
+      ether_mac = Ethernet::Devices.mac eth_device
+      filter += [
+        # A <- first byte of destination MAC address
+        [0x30, 0, 0, 0],  # BPF_LD + BPF_B + BPF_ABS
+        # if A & 1 (multicast MAC address) jump above exact MAC match
+        [0x45, 5, 0, 1],   # BPF_JMP + BPF_JSET + BPF_K
+        
+        # A <- first 4 bytes of destination MAC addres
+        [0x20, 0, 0, 0],  # BPF_LD + BPF_W + BPF_ABS
+        # if A != first 4 bytes of local MAC address jump to drop instruction
+        [0x15, 0, 2, ether_mac.unpack('N').first],  # BPF_JMP + BPF_JEQ + BPF_K
+        # A <- last 2 bytes of destination MAC address
+        [0x28, 0, 0, 4],  # BPF_LD + BPF_H + BPF_ABS
+        # if A == last 2 bytes of local MAC address jump above next instruction
+        [0x15, 1, 0,
+            ether_mac.unpack('@4n').first],  # BPF_JMP + BPF_JEQ + BPF_K
+        # drop packet (ret K = 0)
+        [0x06, 0, 0, 0],  # BPF_RET + BPF_K
+
+        # A <- packet length
+        [0x80, 0, 0, 0],  # BPF_LD + BPF_W + BPF_LEN
+        # ret A (accept the entire packet)
+        [0x16, 0, 0, 0]  # BPF_RET + BPF_A
+      ]
+      filter_code = filter.map { |i| i.pack('SCCL') }.join('')
+      # struct bpf_program in /usr/include/net/bpf.h
+      filter_code_ptr = FFI::MemoryPointer.new :char, filter_code.length + 1
+      filter_code_ptr.write_string filter_code
+      if Ethernet::Provisioning::POINTER_SIZE == 8
+        pack_spec = 'QQ'
+      else
+        pack_spec = 'LL'
+      end
+      bpf_program = [filter.length, filter_code_ptr.address].pack pack_spec
+      # BIOCSETF in /usr/include/net/bpf.h
+      # _IOW in /usr/include/sys/iocom.h
+      bpf.ioctl 0x80104267, bpf_program
+    end
+    private :set_bpf_eth_device
+  end
+end  # module Ethernet::RawSocketFactory
+
+# :nodoc: namespace
+module RawSocketFactory
+
+# Wraps a BPF file descriptor into a socket-like interface.  
+class BpfSocketWrapper
+  # Creates a wrapper for a BPF file descriptor.
+  def initialize(bpf)
+    @bpf = bpf
+    @read_size = read_buffer_length
+    @queue = []
+  end
+  
+  # Implements Socket#recv.
+  def recv(buffer_size)
+    while @queue.empty?
+      read_buffer = @bpf.sysread @read_size
+      bytes_read = read_buffer.length
+      offset = 0
+      while offset < bytes_read
+        # struct bpf_hdr in /usr/include/net/bpf.h
+        timestamp, captured_size, original_size, header_size =
+            *read_buffer.unpack('QLLS')
+        @queue.push read_buffer[header_size, captured_size]
+        # BPF_WORDALIGN in /usr/include/net/bpf.h
+        offset += (header_size + captured_size + 3) & 0xFFF4
+      end
+    end
+    @queue.shift
+  end
+  
+  # Implements Socket#send.
+  def send(buffer, flags)
+    @bpf.write buffer
+  end
+  
+  # Implements Socket#close.
+  def close
+    @bpf.close
+  end
+
+  # The required length of the buffer passed to the read command.
+  def read_buffer_length
+    io_buffer = [0].pack('L')
+    # BIOCGBLEN in /usr/include/net/bpf.h
+    # _IOR in /usr/include/sys/ioccom.h
+    @bpf.ioctl 0x40044266, io_buffer
+    io_buffer.unpack('L').first
+  end
+  private :read_buffer_length
+end  # class Ethernet::RawSocketFactory::BpfSocketWrapper
+
+end  # namespace Ethernet::RawSocketFactory
+
+end  # namespace Ethernet

data/lib/ethernet/raw_socket_factory_linux.rb

@@ -0,0 +1,44 @@
+require 'socket'
+
+# :nodoc: namespace
+module Ethernet
+
+# Low-level socket creation functionality.
+module RawSocketFactory
+  # :nodoc: Linux-specific implementation
+  def self.socket(eth_device, ether_type = nil)
+    ether_type ||= all_ethernet_protocols
+    socket = Socket.new raw_address_family, Socket::SOCK_RAW,
+                        htons(ether_type)
+    socket.setsockopt Socket::SOL_SOCKET, Socket::SO_BROADCAST, true
+    set_socket_eth_device socket, eth_device, ether_type
+    socket
+  end
+  
+  class <<self
+    # Sets the Ethernet interface and protocol type for a socket.
+    def set_socket_eth_device(socket, eth_device, ether_type)
+      if_number = Ethernet::Devices.interface_index eth_device
+      # struct sockaddr_ll in /usr/include/linux/if_packet.h
+      socket_address = [raw_address_family, htons(ether_type), if_number,
+                        0xFFFF, 0, 0, ''].pack 'SSISCCa8'
+      socket.bind socket_address
+      socket
+    end
+    private :set_socket_eth_device
+    
+    # The protocol number for listening to all ethernet protocols.
+    def all_ethernet_protocols
+      3  # cat /usr/include/linux/if_ether.h | grep ETH_P_ALL
+    end
+    private :all_ethernet_protocols
+    
+    # The AF / PF number for raw sockets.
+    def raw_address_family
+      17  # cat /usr/include/bits/socket.h | grep PF_PACKET
+    end
+  end
+end  # module Ethernet::RawSocketFactory
+
+end  # namespace Ethernet
+

data/spec/ethernet/frame_socket_spec.rb

@@ -5,6 +5,7 @@ describe Ethernet::FrameSocket do
   let(:eth_type) { 0x0800 }
   let(:mac) { Ethernet::Devices.mac eth_device }
   let(:dest_mac) { "\x00\x11\x22\x33\x44\x55" }
+  let(:wrong_mac) { "\x02\x11\x22\x33\x44\x55" }
   let(:bcast_mac) { "\xff" * 6 }
   
   shared_examples_for 'a real socket' do
@@ -38,7 +39,7 @@ describe Ethernet::FrameSocket do
     let(:socket_stub) do
       RawSocketStub.new([
         [mac, dest_mac, "\x88\xB7", 'Wrong Ethernet type'].join,
-        [bcast_mac, dest_mac, [eth_type].pack('n'), 'Wrong dest MAC'].join,
+        [wrong_mac, dest_mac, [eth_type].pack('n'), 'Wrong dest MAC'].join,
         [mac, bcast_mac, [eth_type].pack('n'), 'Bcast'].join,
         [mac, dest_mac, [eth_type].pack('n'), 'Correct'].join,
       ])

data/spec/ethernet/raw_socket_factory_spec.rb

@@ -20,7 +20,7 @@ describe Ethernet::RawSocketFactory do
     end
 
     it 'should receive some network noise' do
-      @socket.recv(8192).should_not be_empty
+      @socket.recv(4096).should_not be_empty
     end
   end
 end

data/spec/ethernet_spec.rb

@@ -16,7 +16,7 @@ describe Ethernet do
       Ethernet.devices.should == golden
     end
     
-    let (:devices) { Ethernet.devices }
+    let(:devices) { Ethernet.devices }
     
     it 'contains at least one device' do
       devices.keys.should have_at_least(1).name

data/spec/support/ifconfig_cli.rb

@@ -1,14 +1,25 @@
+require 'English'
+
 # Wraps ifconfig calls useful for testing.
 module IfconfigCli
   # Runs ifconfig and parses its output.
   def self.run
-    case RUBY_PLATFORM
-    when /win/
-    else
+    output = nil
+    windows = false
+    begin
       output = `ifconfig -a`
+    rescue Errno::ENOENT
+      output = `ipconfig /a`
+      windows = true
+    end
+    
+    if windows
+      raise 'Windows support not yet implemented'
+    else
       info_blocks = output.split /\n(?=\w)/ 
-      Hash[info_blocks.map { |i|
+      devices = Hash[info_blocks.map { |i|
         name = i.split(' ', 2).first
+        name = name[0...-1] if name[-1, 1] == ':'  # OSX
         mac = if match = /hwaddr\s([0-9a-f:]+)\s/i.match(i)
           # Linux ifconfig output.
           match[1].gsub(':', '').downcase
@@ -21,10 +32,11 @@ module IfconfigCli
         else
           nil
         end
-        active = /inet\s/.match(i) ? true : false
+        active = (/inet\s/i.match(i) || /inet6\s/i.match(i)) ? true : false
         [name, { :mac => mac, :active => active }]
       }]
     end
+    devices.delete_if { |k, v| v[:mac].nil? }
   end
   
   # The name of the first active Ethernet device.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ethernet
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Victor Costan
@@ -16,24 +16,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-27 00:00:00 Z
+date: 2011-05-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 23
         segments: 
-        - 0
         - 1
-        - 1
-        version: 0.1.1
+        - 0
+        - 0
+        version: 1.0.0
   prerelease: false
   version_requirements: *id001
-  name: system-getifaddrs
+  name: ffi
 - !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
@@ -134,9 +134,13 @@ files:
 - ethernet.gemspec
 - lib/ethernet.rb
 - lib/ethernet/devices.rb
+- lib/ethernet/devices_darwin.rb
+- lib/ethernet/devices_linux.rb
 - lib/ethernet/frame_socket.rb
 - lib/ethernet/provisioning.rb
 - lib/ethernet/raw_socket_factory.rb
+- lib/ethernet/raw_socket_factory_darwin.rb
+- lib/ethernet/raw_socket_factory_linux.rb
 - spec/ethernet/devices_spec.rb
 - spec/ethernet/frame_socket_spec.rb
 - spec/ethernet/raw_socket_factory_spec.rb