ether_ping 0.1.0

data/.document

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

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>ether_ping</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'ethernet', '>= 0.1.0'
+
+group :development do
+  gem 'rdoc', '>= 3.6.1'
+  gem 'rspec', '~> 2.6.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.6.0'
+  gem 'rcov', '>= 0'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    ethernet (0.1.1)
+      system-getifaddrs (~> 0.1.1)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.0)
+    rcov (0.9.9)
+    rdoc (3.6.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.3)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    system-getifaddrs (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  ethernet (>= 0.1.0)
+  jeweler (~> 1.6.0)
+  rcov
+  rdoc (>= 3.6.1)
+  rspec (~> 2.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Victor Costan
+
+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,39 @@
+= ether_ping
+
+Command-line tool providing a ping equivalent for Ethernet frames.
+
+== Usage
+
+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
+    
+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
+
+    ether_ping eth0 c42c0337fffc aabbccdd
+
+
+== Contributing to ether_ping
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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
+
+Victor Costan victor@costan.us
+
+== Copyright
+
+Copyright (c) 2011 Massachusetts Institute of Technology. 
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ether_ping"
+  gem.homepage = "http://github.com/pwnall/ether_ping"
+  gem.license = "MIT"
+  gem.summary = %Q{Command-line ping equivalent for Ethernet frames.}
+  gem.description = %Q{Contains an Ethernet-level ping server and client.}
+  gem.email = "victor@costan.us"
+  gem.authors = ["Victor Costan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ether_ping #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/ether_ping

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+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
+  ether_type: packet type for the Ethernet II frame, in hex (2 bytes)
+  dest_mac: destination MAC for the ping packets, in hex (6 bytes)
+  data: ping packet data, in hex (0-padded to 64 bytes)
+
+Available Ethernet interfaces:
+#{Ethernet.devices.keys.sort.join("\n")}
+END_USAGE
+  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
+
+client = EtherPing::Client.new interface, ether_type, dest_mac
+
+loop do
+  print "Pinging #{dest_mac}... "
+  STDOUT.flush
+  puts client.ping(data) ? "OK" : "Failed"
+  STDOUT.flush
+  sleep 1
+end

data/bin/ether_ping_server

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+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
+end
+ 
+interface = ARGV[0]
+ether_type = [ARGV[1] || '88B5'].pack('H*').unpack('n').first
+
+ping_server = EtherPing::Server.new interface, ether_type
+ping_server.run

data/ether_ping.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ether_ping}
+  s.version = "0.1.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-27}
+  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}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".project",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/ether_ping",
+    "bin/ether_ping_server",
+    "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"
+  ]
+  s.homepage = %q{http://github.com/pwnall/ether_ping}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.4}
+  s.summary = %q{Command-line ping equivalent for Ethernet frames.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ethernet>, [">= 0.1.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<ethernet>, [">= 0.1.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"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ethernet>, [">= 0.1.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"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/ether_ping/client.rb

@@ -0,0 +1,37 @@
+require 'ethernet'
+
+# :nodoc: namespace
+module EtherPing
+  
+# ether_ping implementation.
+class Client
+  def initialize(eth_device, ether_type, destination_mac)
+    @socket = Ethernet.raw_socket eth_device, ether_type
+    @source_mac = Ethernet::Devices.mac eth_device
+    @dest_mac = [destination_mac].pack('H*')[0, 6]
+    @ether_type = [ether_type].pack('n')    
+  end
+  
+  attr_reader :socket
+  attr_reader :source_mac
+  attr_reader :dest_mac
+  
+  # Pings over raw Ethernet sockets.
+  #
+  # Returns true if the ping receives a response, false otherwise.
+  def ping(data, timeout = 1)
+    data = data.clone
+    # 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
+
+    response_packet = @source_mac + @dest_mac + @ether_type + data
+    response = @socket.recv response_packet.length * 2
+    
+    response == response_packet
+  end
+end  # module EtherPing::Client
+
+end  # namespace EtherPing

data/lib/ether_ping/server.rb

@@ -0,0 +1,48 @@
+require 'ethernet'
+
+# :nodoc: namespace
+module EtherPing
+
+# Responder for ping utility using raw Ethernet sockets.
+class Server
+  module Connection
+    def receive_data(packet)
+      source_mac = packet[0, 6].unpack('H*')
+      dest_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 ARP 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
+    end
+  end
+  
+  def initialize(eth_device, ether_type)
+    @socket = Ethernet.raw_socket eth_device, ether_type
+  end
+end  # module EtherPing::Server
+  
+end  # namespace EtherPing

data/lib/ether_ping.rb

@@ -0,0 +1,6 @@
+# Documentation here.
+module EtherPing
+end
+
+require 'ether_ping/client.rb'
+require 'ether_ping/server.rb'

data/spec/ether_ping_spec.rb

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,12 @@
+$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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification 
+name: ether_ping
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-27 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: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  prerelease: false
+  version_requirements: *id001
+  name: ethernet
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 3
+        - 6
+        - 1
+        version: 3.6.1
+  prerelease: false
+  version_requirements: *id002
+  name: rdoc
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  prerelease: false
+  version_requirements: *id003
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  version_requirements: *id004
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  prerelease: false
+  version_requirements: *id005
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  version_requirements: *id006
+  name: rcov
+description: Contains an Ethernet-level ping server and client.
+email: victor@costan.us
+executables: 
+- ether_ping_server
+- ether_ping
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .project
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/ether_ping
+- bin/ether_ping_server
+- 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
+homepage: http://github.com/pwnall/ether_ping
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Command-line ping equivalent for Ethernet frames.
+test_files: []
+