pio 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42e4ddeb113721d1515042c5b21242f7f5f49f76
-  data.tar.gz: 4d135571f99d94db9e3b0f534e8154669da4360d
+  metadata.gz: a99eb3c57f09bc9a82c53d916636509695770620
+  data.tar.gz: 5da352b9a4cbe2660ce0fc71e086f15c697f52b2
 SHA512:
-  metadata.gz: bae38aa9d987cfd6965b4657222e8713dc4e019d655bcc4fc2b81c1bdee8fa03d5b9795324b8915290e56d78ae4b8b93584d071b0cc65ab921b64da47b7cb61c
-  data.tar.gz: 0ff3e93fc9a7159807c3ed2bb01fb8ff045e948e34ee32a1956b6856fa9ec24c8734b2287bffd5fe77d66194e29c5e5d85f63db329495cfa480af23971e3bf9f
+  metadata.gz: 50e299558aea50ece6f430e007b428b9b5cc53439883043aca7128fe67ed3d08c50ec2e8ffac4f5d115735e77eb09289d25a249ee22f812edfbca2f91289aacc
+  data.tar.gz: b01bab2207f6556d2ca45ff72281c1475195511767d64b6b4847100961ada881b3406aeee2cd068d6998881f08d07dc026ca6c991a594a87d84aa2e722dd419e

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/Gemfile

@@ -4,14 +4,15 @@ source "https://rubygems.org"
 gemspec
 
 
-group :development do
+group :development, :test do
   gem "coveralls", "~> 0.6.7", :require => false
   gem "flay", "~> 2.4.0"
   gem "flog", "~> 4.1.1"
+  gem "fuubar", "~> 1.2.1"
   gem "guard", "~> 1.8.2"
   gem "guard-bundler", "~> 1.0.0"
   gem "guard-rspec", "~> 3.0.2"
-  gem "json", "~> 1.8.0" if RUBY_VERSION < "1.9.0"
+  gem "json", "~> 1.8.0"
   gem "rake", "~> 10.1.0"
   gem "rb-fchange", "~> 0.0.6", :require => false
   gem "rb-fsevent", "~> 0.9.3", :require => false

data/Guardfile

@@ -1,6 +1,9 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
+notification :terminal_notifier
+notification :tmux, :display_message => true
+
 
 guard 'bundler' do
   watch('Gemfile')
@@ -11,6 +14,6 @@ end
 
 guard :rspec do
   watch(%r{^spec/pio/.+_spec\.rb$})
-  watch(%r{^lib/pio/(.+)\.rb$})     { |m| "spec/lib/pio/#{m[1]}_spec.rb" }
+  watch(%r{^lib/pio/(.+)\.rb$})     { |m| "spec/pio/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -10,7 +10,8 @@ Pio
 
 Pio is a ruby gem to easily parse and generate network packets. It supports the following packet formats:
 
- * [LLDP](http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol)
+ * ARP
+ * LLDP
  * (...currently there are just a few formats supported but I'm sure this list will grow)
 
 
@@ -25,14 +26,51 @@ Features Overview
  * Clean Code. Pio is built on
    [BinData](https://github.com/dmendel/bindata)'s declarative binary
    format DSL so that it is easy to read and debug by human beings.
- 
+
 
 Example
 -------
 
-Its usage is dead simple: to parse an LLDP frame for example, use the
-API `Pio::Lldp.read` and you can access each field of the parsed LLDP
-frame.
+Its usage is dead simple.
+
+### ARP
+
+To parse an ARP frame, use the API `Pio::Arp.read` and you can access
+each field of the parsed ARP frame.
+
+```ruby
+require "pio"
+
+arp = Pio::Arp.read( binary_data )
+arp.source_mac.to_s #=> "00:26:82:eb:ea:d1"
+```
+
+Also you can use `Pio::Arp::Request#new` or `Pio::Arp::Reply#new` to
+generate an Arp Request/Reply frame like below:
+
+```ruby
+require "pio"
+
+request = Pio::Arp::Request.new(
+  source_mac: "00:26:82:eb:ea:d1",
+  sender_protocol_address: "192.168.83.3",
+  target_protocol_address: "192.168.83.254"
+)
+request.to_binary  #=> Arp Request frame in binary format.
+
+reply = Pio::Arp::Reply.new(
+  source_mac: "00:26:82:eb:ea:d1",
+  destination_mac: "00:26:82:eb:ea:d1",
+  sender_protocol_address: "192.168.83.3",
+  target_protocol_address: "192.168.83.254"
+)
+reply.to_binary  #=> Arp Reply frame in binary format.
+```
+
+### LLDP
+
+To parse an LLDP frame, use the API `Pio::Lldp.read` and you can
+access each field of the parsed LLDP frame.
 
 ```ruby
 require "pio"
@@ -46,7 +84,7 @@ Also you can use `Pio::Lldp#new` to generate an LLDP frame like below:
 ```ruby
 require "pio"
 
-lldp = Pio::Lldp.new( 0x123, 12 )  # dpid and port_number
+lldp = Pio::Lldp.new( dpid: 0x123, port_number: 12 )
 lldp.to_binary  #=> LLDP frame in binary format.
 ```
 

data/Rakefile

@@ -1,21 +1,3 @@
-#
-# Copyright (C) 2013 NEC Corporation
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License, version 3, as
-# published by the Free Software Foundation.
-#
-# 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
-#
-
-
 require "bundler/gem_tasks"
 require "coveralls/rake/task"
 require "flay"
@@ -34,19 +16,19 @@ $ruby_source = FileList[ "lib/**/*.rb" ]
 
 task :default => :travis
 task :travis => [ :spec, :quality, "coveralls:push" ]
+
+desc "Check for code quality"
 task :quality => [ :reek, :flog, :flay ]
 
 
 Coveralls::RakeTask.new
 
 
-RSpec::Core::RakeTask.new do | task |
-  task.rspec_opts = "--format documentation --color"
-end
+RSpec::Core::RakeTask.new
 
 
 Reek::Rake::Task.new do | t |
-  t.fail_on_error = true
+  t.fail_on_error = false
   t.verbose = false
   t.ruby_opts = [ "-rubygems" ]
   t.reek_opts = "--quiet"
@@ -69,7 +51,7 @@ task :flog do
     puts "%8.1f: %s" % [ score, name ]
   end
   unless bad_methods.empty?
-    raise "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+    $stderr.puts "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
   end
 end
 

data/lib/pio.rb

@@ -0,0 +1,15 @@
+require "pio/arp"
+require "pio/lldp"
+
+
+module Pio
+  # Raised when the packet data is in wrong format.
+  class ParseError < StandardError; end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/arp.rb

@@ -0,0 +1,31 @@
+require "rubygems"
+require "bindata"
+
+require "pio/arp/request"
+require "pio/arp/reply"
+
+
+module Pio
+  # ARP parser and generator.
+  class Arp
+    ARP_MESSAGE_TYPE = { Request::OPERATION => Request, Reply::OPERATION => Reply }
+
+
+    def self.read( raw_data )
+      begin
+        frame = Arp::Frame.read( raw_data )
+      rescue
+        raise Pio::ParseError, $!.message
+      end
+
+      ARP_MESSAGE_TYPE[ frame.operation ].create_from frame
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/arp/frame.rb

@@ -0,0 +1,38 @@
+require "pio/type/ethernet-header"
+require "pio/type/ip-address"
+require "pio/type/mac-address"
+
+
+module Pio
+  class Arp
+    # ARP frame parser.
+    class Frame < BinData::Record
+      extend Type::EthernetHeader
+
+      endian :big
+
+      ethernet_header :ether_type => 0x0806
+      uint16 :hardware_type, :value => 1
+      uint16 :protocol_type, :value => 0x0800
+      uint8 :hardware_length, :value => 6
+      uint8 :protocol_length, :value => 4
+      uint16 :operation
+      mac_address :sender_hardware_address
+      ip_address :sender_protocol_address
+      mac_address :target_hardware_address
+      ip_address :target_protocol_address
+
+
+      def to_binary
+        to_binary_s + "\000" * ( 64 - num_bytes )
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/arp/message.rb

@@ -0,0 +1,66 @@
+require "pio/arp/frame"
+require "forwardable"
+
+
+module Pio
+  class Arp
+    # Base class of ARP Request and Reply
+    class Message
+      extend Forwardable
+
+
+      def self.create_from frame
+        message = allocate
+        message.instance_variable_set :@frame, frame
+        message
+      end
+
+
+      def initialize options
+        @options = options
+        @frame = Arp::Frame.new( option_hash )
+      end
+
+
+      def_delegators :@frame, :destination_mac
+      def_delegators :@frame, :source_mac
+      def_delegators :@frame, :ether_type
+      def_delegators :@frame, :hardware_type
+      def_delegators :@frame, :protocol_type
+      def_delegators :@frame, :hardware_length
+      def_delegators :@frame, :protocol_length
+      def_delegators :@frame, :operation
+      def_delegators :@frame, :sender_hardware_address
+      def_delegators :@frame, :sender_protocol_address
+      def_delegators :@frame, :target_hardware_address
+      def_delegators :@frame, :target_protocol_address
+      def_delegators :@frame, :to_binary
+
+
+      ##########################################################################
+      private
+      ##########################################################################
+
+
+      def option_hash
+        mandatory_options.inject( {} ) do | opt, each |
+          klass = option_to_klass[ each ]
+          opt_pair = { each => klass.new( user_options[ each ] ).to_a }
+          opt.merge opt_pair
+        end.merge default_options
+      end
+
+
+      def option_to_klass
+        {
+          :source_mac => Mac,
+          :destination_mac => Mac,
+          :sender_hardware_address => Mac,
+          :target_hardware_address => Mac,
+          :sender_protocol_address => IP,
+          :target_protocol_address => IP,
+        }
+      end
+    end
+  end
+end

data/lib/pio/arp/reply.rb

@@ -0,0 +1,55 @@
+require "forwardable"
+require "pio/arp/message"
+require "pio/ip"
+require "pio/mac"
+
+
+module Pio
+  class Arp
+    # ARP Reply packet generator
+    class Reply < Message
+      OPERATION = 2
+
+
+      ##########################################################################
+      private
+      ##########################################################################
+
+
+      def default_options
+        {
+          :operation => OPERATION,
+        }
+      end
+
+
+      def user_options
+        @options.merge(
+          {
+            :sender_hardware_address => @options[ :source_mac ],
+            :target_hardware_address => @options[ :destination_mac ]
+          }
+        )
+      end
+
+
+      def mandatory_options
+        [
+          :source_mac,
+          :destination_mac,
+          :sender_hardware_address,
+          :target_hardware_address,
+          :sender_protocol_address,
+          :target_protocol_address,
+        ]
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/arp/request.rb

@@ -0,0 +1,55 @@
+require "pio/arp/frame"
+require "pio/arp/message"
+require "pio/ip"
+require "pio/mac"
+
+
+module Pio
+  class Arp
+    # ARP Request packet generator
+    class Request < Message
+      OPERATION = 1
+
+      BROADCAST_MAC_ADDRESS = Mac.new( 0xffffffffffff ).to_a
+      ALL_ZERO_MAC_ADDRESS = Mac.new( 0 ).to_a
+
+
+      ########################################################################
+      private
+      ########################################################################
+
+
+      def default_options
+        {
+          :operation => OPERATION,
+          :destination_mac => BROADCAST_MAC_ADDRESS,
+          :target_hardware_address => ALL_ZERO_MAC_ADDRESS
+        }
+      end
+
+
+      def user_options
+        @options.merge(
+          { :sender_hardware_address => @options[ :source_mac ] }
+        )
+      end
+
+
+      def mandatory_options
+        [
+          :source_mac,
+          :sender_hardware_address,
+          :sender_protocol_address,
+          :target_protocol_address,
+        ]
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: