ether_ping 0.2.0 → 0.3.0

data/Gemfile

@@ -7,5 +7,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,8 +2,9 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    ethernet (0.1.1)
-      system-getifaddrs (~> 0.1.1)
+    ethernet (0.1.2)
+      ffi (>= 1.0.0)
+    ffi (1.0.9)
     git (1.2.5)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
@@ -20,7 +21,6 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    system-getifaddrs (0.1.1)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -8,16 +8,14 @@ While ping uses an echo service embedded in every TCP/IP stack, ether_ping
 relies on a server program to have its frames echoed. First start the server on
 the destination computer, and tell it what Ethernet device it should listen to.
 
-    ether_ping_server eth0  # on Linux
-    ether_ping_server en0   # on Mac OS
+    ether_ping_server -e eth0  # on Linux
+    ether_ping_server -e en0   # on Mac OS
     
-Then launch the ping utility. It wants to know the following information:
-* the Ethernet device that will be used for sending ping frames
-* the MAC of the destination's Ethernet device
-* the data to be sent
+Then launch the ping utility.
 
-    ether_ping eth0 c42c0337fffc aabbccdd
+    ether_ping -e eth0 c42c0337fffc
 
+Both commands accept the -h / --help option.
 
 == Contributing to ether_ping
  

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/ether_ping

@@ -1,41 +1,62 @@
 #!/usr/bin/env ruby
+require 'optparse'
+
 require 'rubygems'
 require 'ether_ping'
 
-if ARGV.length < 3
-  print <<END_USAGE
-Usage: #{$0} net_interface dest_mac [ether_type] data
-  net_interface: name of the Ethernet interface, e.g. eth0
-  dest_mac: destination MAC for the ping packets, in hex (6 bytes)
-  ether_type: packet type for the Ethernet II frame, in hex (2 bytes)
-  data: ping packet data, in hex (0-padded to 64 bytes)
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] destination_mac"
+  
+  opts.on('-e', '--interface ETH', 'Ethernet interface name, e.g. eth0') do |i|
+    options[:interface] = i
+  end
+  
+  opts.on('-t', '--type TYPE',
+          'Ethernet II frame type, as 2 hex bytes, e.g. 0800 for IP') do |p|
+    options[:ether_type] = [p].pack('H*').unpack('n').first
+  end
+  
+  opts.on('-d', '--data HEXBYTES',
+          'Ping packet data, in a sequence of hexadecimal bytes') do |d|
+    options[:data] = [d].pack('H*')
+  end
+  
+  opts.on('-s', '--size SIZE', 'Number of bytes in a ping packet') do |s|
+    options[:size] = s.to_i
+  end
+  
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+options[:interface] ||= Ethernet.devices.keys.sort.first
+options[:ether_type] ||= 0x88B5
+options[:size] ||= 64 unless options[:data]
 
-Available Ethernet interfaces:
-#{Ethernet.devices.keys.sort.join("\n")}
-END_USAGE
+if ARGV.length < 1
+  puts "Missing destination MAC address"
   exit 1
 end
- 
-interface = ARGV[0]
-dest_mac = ARGV[1]
-if ARGV.length == 3
-  ether_type_string = '88B5'
-  data = [ARGV[2]].pack('H*')
-else
-  ether_type_string = ARGV[2]
-  data = [ARGV[3]].pack('H*')
-end
-ether_type = [ether_type_string].pack('H*').unpack('n').first
+destination_mac = ARGV.first
+
+print "Pinging #{destination_mac} on #{options[:interface]} "
+print "with a #{options[:size] || options[:data].length}-byte frame "
+print "of type #{'%04X' % options[:ether_type]}\n"
 
-client = EtherPing::Client.new interface, ether_type, dest_mac
+client = EtherPing::Client.new options[:interface], options[:ether_type],
+                               destination_mac
 
 loop do
-  print "Pinging #{dest_mac}... "
+  print "Ping... "
   STDOUT.flush
-  result = client.ping data
+  result = client.ping options[:size] || options[:data]
   if result
-    if result == true
-      puts "OK"
+    if result.kind_of? Numeric
+      puts "#{result * 1000000}us"
     else
       puts "Failed"
       puts "Expected:\n#{result.first.unpack('H*').first}"

data/bin/ether_ping_server

@@ -1,22 +1,39 @@
 #!/usr/bin/env ruby
+require 'optparse'
+
 require 'rubygems'
 require 'ether_ping'
 
-if ARGV.length < 1
-  print <<END_USAGE
-Usage: #{$0} net_interface [ether_type]
-  net_interface: name of the Ethernet interface, e.g. eth0
-  ether_type: packet type for the Ethernet II frame, in hex (2 bytes)
-              the default is 88B5, intended for research and experiments
-
-Available Ethernet interfaces:
-#{Ethernet.devices.keys.sort.join("\n")}
-END_USAGE
-  exit 1
+options = { :verbose => true }
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+  
+  opts.on('-e', '--interface ETH', 'Ethernet interface name, e.g. eth0') do |i|
+    options[:interface] = i
+  end
+  
+  opts.on('-t', '--type TYPE',
+          'Ethernet II frame type, as 2 hex bytes, e.g. 0800 for IP') do |p|
+    options[:ether_type] = [p].pack('H*').unpack('n').first
+  end
+  
+  opts.on('-s', '--silent', 'Do not display packets as they come in') do
+    options[:verbose] = false
+  end
+  
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
 end
- 
-interface = ARGV[0]
-ether_type = [ARGV[1] || '88B5'].pack('H*').unpack('n').first
 
-ping_server = EtherPing::Server.new interface, ether_type
+parser.parse!
+options[:interface] ||= Ethernet.devices.keys.sort.first
+options[:ether_type] ||= 0x88B5
+interface_mac = Ethernet::Devices.mac(options[:interface]).unpack('H*').first
+
+print "Waiting for frames of type #{'%04X' % options[:ether_type]} "
+print "on #{options[:interface]} with MAC #{interface_mac}\n"
+ping_server = EtherPing::Server.new options[:interface], options[:ether_type],
+                                    options[:verbose]
 ping_server.run

data/ether_ping.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ether_ping}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Victor Costan}]
-  s.date = %q{2011-05-29}
+  s.date = %q{2011-05-30}
   s.description = %q{Contains an Ethernet-level ping server and client.}
   s.email = %q{victor@costan.us}
   s.executables = [%q{ether_ping_server}, %q{ether_ping}]
@@ -32,9 +32,7 @@ Gem::Specification.new do |s|
     "ether_ping.gemspec",
     "lib/ether_ping.rb",
     "lib/ether_ping/client.rb",
-    "lib/ether_ping/server.rb",
-    "spec/ether_ping_spec.rb",
-    "spec/spec_helper.rb"
+    "lib/ether_ping/server.rb"
   ]
   s.homepage = %q{http://github.com/pwnall/ether_ping}
   s.licenses = [%q{MIT}]

data/lib/ether_ping/client.rb

@@ -18,28 +18,36 @@ class Client
   
   # Pings over raw Ethernet sockets.
   #
-  # Returns true if the ping response matches, an array of [expected,
-  # received] strings if it doesn't match, and false if the ping times out.
+  # Returns a Number representing the ping latency (in seconds) if the ping
+  # response matches, an array of [expected, received] strings if it doesn't
+  # match, and false if the ping times out.
   def ping(data, timeout = 1)
-    data = data.clone
+    if data.kind_of? Numeric
+      data = "\0" * data
+    end
     # Pad data to have at least 64 bytes.
     data += "\0" * (64 - data.length) if data.length < 64
  
-    ping_packet = @dest_mac + @source_mac + @ether_type + data
-    @socket.send ping_packet, 0
+    ping_packet = [@dest_mac, @source_mac, @ether_type, data].join
 
-    response_packet = @source_mac + @dest_mac + @ether_type + data
-    
     response = nil
+    receive_ts = nil
+    send_ts = nil
     begin
       Timeout.timeout timeout do
-        response = @socket.recv response_packet.length * 2
+        send_ts = Time.now
+        @socket.send ping_packet, 0
+        response = @socket.recv ping_packet.length * 2
+        receive_ts = Time.now
       end
     rescue Timeout::Error
       response = nil
     end
     return false unless response
-    response == response_packet || [response, response_packet]
+
+    response_packet = [@source_mac, @dest_mac, @ether_type, data].join
+    response == response_packet ? receive_ts - send_ts :
+                                  [response, response_packet]
   end
 end  # module EtherPing::Client
 

data/lib/ether_ping/server.rb

@@ -7,43 +7,28 @@ module EtherPing
 
 # Responder for ping utility using raw Ethernet sockets.
 class Server
-  module Connection
-    def receive_data(packet)
-      dest_mac = packet[0, 6].unpack('H*')
-      source_mac = packet[6, 6].unpack('H*')
-      ether_type = packet[12, 2].unpack('H*')
-      
-      puts "Src: #{source_mac} Dst: #{dest_mac} Eth: #{ether_type}\n"
-      puts packet[14..-1].unpack('H*')
-      
-      # Exchange the source and destination MAC addresses.
-      packet[0, 6], packet[6, 6] = packet[6, 6], packet[0, 6]
-      send_data packet
-    end
-  end
-
-  class ConnectionWrapper
-    include Connection
-    
-    def initialize(socket)
-      @socket = socket
-    end
-    
-    def send_data(data)
-      @socket.send data, 0
-    end
-  end
-  
   def run
-    connection = ConnectionWrapper.new @socket
     loop do
       packet = @socket.recv 65536
-      connection.receive_data packet
+      # Respond afap: exchange the source and destination MAC addresses.
+      packet[0, 6], packet[6, 6] = packet[6, 6], packet[0, 6]
+      @socket.send packet, 0
+  
+      if @verbose
+        # The MAC addresses were switched above, before responding.
+        dest_mac = packet[6, 6].unpack('H*').first
+        source_mac = packet[0, 6].unpack('H*').first
+        ether_type = packet[12, 2].unpack('H*').first
+          
+        puts "Src: #{source_mac} Dst: #{dest_mac} Eth: #{ether_type} Data:\n"
+        puts packet[14..-1].unpack('H*').first
+      end
     end
   end
   
-  def initialize(eth_device, ether_type)
+  def initialize(eth_device, ether_type, verbose = true)
     @socket = Ethernet.raw_socket eth_device, ether_type
+    @verbose = verbose
   end
 end  # module EtherPing::Server
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ether_ping
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Victor Costan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-29 00:00:00 Z
+date: 2011-05-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -137,8 +137,6 @@ files:
 - lib/ether_ping.rb
 - lib/ether_ping/client.rb
 - lib/ether_ping/server.rb
-- spec/ether_ping_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/pwnall/ether_ping
 licenses: 
 - MIT

data/spec/ether_ping_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "EtherPing" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'ether_ping'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end