pio 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46ff2e5ea71119c5c3f334e9714aad64c6394416
-  data.tar.gz: f8d3b344b34473f4ff12992e86ee02db5e97f750
+  metadata.gz: 7440562aee407d80e2f3f795a40fb065b6a6189a
+  data.tar.gz: f28861cef1a8a0a3e2807b77a62ddd5bbc98ac47
 SHA512:
-  metadata.gz: d12b409112666b903cd16280299613440986d86d199e6cf1eff4d1631ba6580c792bc539fac1f4c19017014a6999b2bdb05e4a501b9b4a10ec9332d0f4759afd
-  data.tar.gz: c44a02181e9b75710884acf48773d1f0a287c07d13e96c9f86a25552a4e22682eced7409f32f061836dc7f0a838e4dffa9e42bf41f0a10e0dfc38d706426418e
+  metadata.gz: dc1f92d485a60ec4e53bb6e260962ed56186d89ddf4e79c4e4abcb4c2a3dd7140101e41a765c93502936d170082bd83fc669c165efcc49c3a0a14c44331dc7d1
+  data.tar.gz: 5af6281ba069a05d1ebd7f7608d5e2a01f2c80c60f5c0d6de22ab0463ae8c377841e11ae41c9faca5c078b5dcfb2e9546ebddbd6aa5361a223d9ded017993b58

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## 0.5.0 (4/14/2014)
+
+* Added new class `Pio::Hello`.
+
+### Misc
+
+* Added new rake task `cucumber`.
+* Added new rake task `dump_pcap`.
+
+
+## 0.4.0 (3/31/2014)
+
+### New features
+* Added new classes `Pio::Dhcp`, `Pio::Dhcp::Discover`,
+  `Pio::Dhcp::Offer`, `Pio::Dhcp::Request` and `Pio::Dhcp::Ack`.
+
+### Changes
+* Added new class alias `Pio::ICMP` => `Pio::Icmp`.
+* Added new class alias `Pio::ARP` => `Pio::Arp`.
+* Added new class alias `Pio::LLDP` => `Pio::Lldp`.
+* Added new class alias `Pio::DHCP` => `Pio::Dhcp`.

data/README.md

@@ -16,6 +16,8 @@ supports the following packet formats:
 -   ARP
 -   LLDP
 -   DHCP
+-   OpenFlow 1.0 messages
+    -   Hello
 -   (…currently there are just a few formats supported but I'm sure this list will grow)
 
 ## Features Overview
@@ -158,6 +160,24 @@ Also you can use `Pio::Dhcp::Discover#new`,
     )
     ack.to_binary  # => DHCP Ack frame in binary format
 
+### Hello
+
+To parse an OpenFlow 1.0 Hello message, use the API `Pio::Hello.read`
+and you can access each field of the parsed Hello message.
+
+    require 'pio'
+
+    hello = Pio::Hello.read(binary_data)
+    hello.transaction_id # => 123
+
+Also you can use `Pio::Hello#new` to generate a Hello message like
+below:
+
+    require 'pio'
+
+    hello = Pio::Hello.new(transaction_id: 123)
+    hello.to_binary  # => HELLO message in binary format.
+
 ## Installation
 
 The simplest way to install Pio is to use [Bundler](http://gembundler.com/).

data/Rakefile

@@ -5,8 +5,8 @@ require 'bundler/gem_tasks'
 # rubocop:disable HashSyntax
 
 task :default => :travis
-
-task :travis => [:spec, :quality, 'coveralls:push']
+task :test => [:spec, :cucumber]
+task :travis => [:test, :quality, 'coveralls:push']
 
 desc 'Check for code quality'
 task :quality => [:reek, :flog, :flay, :rubocop]

data/examples/hello_new.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+hello = Pio::Hello.new(transaction_id: 123)
+hello.to_binary  # => HELLO message in binary format.

data/examples/hello_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+hello = Pio::Hello.read(binary_data)
+hello.transaction_id # => 123

data/features/arp_read.feature

@@ -0,0 +1,10 @@
+Feature: Pio::Arp.read
+  Scenario: arp.pcap
+    Given a pcap file "arp.pcap"
+    When I try to parse the pcap file with "Arp" class
+    Then it should finish successfully
+
+  Scenario: arp-storm.pcap
+    Given a pcap file "arp-storm.pcap"
+    When I try to parse the pcap file with "Arp" class
+    Then it should finish successfully

data/features/dhcp_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::Dhcp.read
+  Scenario: dhcp.pcap
+    Given a pcap file "dhcp.pcap"
+    When I try to parse the pcap file with "Dhcp" class
+    Then it should finish successfully

data/features/icmp_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::Icmp.read
+  Scenario: icmp.pcap
+    Given a pcap file "icmp.pcap"
+    When I try to parse the pcap file with "Icmp" class
+    Then it should finish successfully

data/features/lldp_read.feature

@@ -0,0 +1,10 @@
+Feature: Pio::Lldp.read
+  Scenario: lldp.minimal.pcap
+    Given a pcap file "lldp.minimal.pcap"
+    When I try to parse the pcap file with "Lldp" class
+    Then it should finish successfully
+
+  Scenario: lldp.detailed.pcap
+    Given a pcap file "lldp.detailed.pcap"
+    When I try to parse the pcap file with "Lldp" class
+    Then it should finish successfully

data/features/step_definitions/pcap_steps.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+Given(/^a pcap file "(.*?)"$/) do |pcap|
+  @pcap = File.join(File.dirname(__FILE__), '..', 'pcap', pcap)
+end
+
+When(/^I try to parse the pcap file with "(.*?)" class$/) do |parser|
+  File.open(@pcap) do |file|
+    pcap = Pio::Pcap::Frame.read(file)
+    pcap.records.each do |each|
+      Pio.const_get(parser).__send__ :read, each.data
+    end
+  end
+end
+
+Then(/^it should finish successfully$/) do
+  # Noop.
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'pio'
+require 'pio/pcap'

data/lib/pio.rb

@@ -3,7 +3,8 @@
 require 'pio/parse_error'
 
 require 'pio/arp'
-require 'pio/lldp'
+require 'pio/dhcp'
+require 'pio/hello'
 require 'pio/icmp'
+require 'pio/lldp'
 require 'pio/mac'
-require 'pio/dhcp'

data/lib/pio/dhcp/optional_tlv.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
 
-require 'pio/dhcp/type/dhcp_param_list'
-require 'pio/dhcp/type/dhcp_client_id'
-require 'pio/dhcp/type/dhcp_string'
+require 'pio/dhcp/parameter_list'
+require 'pio/dhcp/client_id'
 require 'pio/type/ip_address'
 
 module Pio
@@ -29,7 +28,7 @@ module Pio
         ip_address Dhcp::REQUESTED_IP_ADDRESS_TLV
         client_id Dhcp::CLIENT_IDENTIFIER_TLV
         parameter_list Dhcp::PARAMETERS_LIST_TLV
-        dhcp_string DEFAULT
+        string DEFAULT
       end
 
       def end_of_dhcptlv?

data/lib/pio/dhcp/{type/dhcp_param_list.rb → parameter_list.rb}

@@ -3,7 +3,7 @@
 require 'bindata'
 
 module Pio
-  module Type
+  class Dhcp
     # DHCP ParameterList Format.
     class ParameterList < BinData::Primitive
       array :octets,

data/lib/pio/hello.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'forwardable'
+require 'pio/hello/format'
+
+module Pio
+  # OpenFlow 1.0 Hello message
+  class Hello
+    extend Forwardable
+
+    def_delegators :@data, :version
+    def_delegators :@data, :message_type
+    def_delegators :@data, :message_length
+    def_delegators :@data, :transaction_id
+    def_delegator :@data, :transaction_id, :xid
+    def_delegators :@data, :body
+    def_delegator :@data, :to_binary_s, :to_binary
+
+    def self.read(raw_data)
+      hello = allocate
+      hello.instance_variable_set :@data, Format.read(raw_data)
+      hello
+    end
+
+    def initialize(user_options = {})
+      @options = user_options.dup
+      handle_option_aliases
+      @data = Format.new(@options)
+    end
+
+    private
+
+    def handle_option_aliases
+      @options[:transaction_id] ||= @options[:xid]
+    end
+  end
+end

data/lib/pio/hello/format.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  class Hello
+    # OpenFlow 1.0 Hello message
+    class Format < BinData::Record
+      endian :big
+
+      uint8 :version, value: 1
+      uint8 :message_type
+      uint16 :message_length, initial_value: 8
+      uint32 :transaction_id
+      string :body  # ignored
+    end
+  end
+end

data/lib/pio/ipv4_address.rb

@@ -4,18 +4,13 @@ require 'forwardable'
 require 'ipaddr'
 
 module Pio
-  #
   # IPv4 Address
-  #
   class IPv4Address
     extend Forwardable
 
-    #
     # @return [IPAddr] value object instance of proxied IPAddr.
-    #
     attr_reader :value
 
-    #
     # Creates a {IPv4Address} instance object as a proxy to IPAddr class.
     #
     # @overload initialize(addr)
@@ -27,7 +22,6 @@ module Pio
     #
     # @return [IPv4Address] self
     #   a proxy to IPAddr.
-    #
     def initialize(addr)
       case addr
       when Integer
@@ -41,26 +35,18 @@ module Pio
       end
     end
 
-    #
     # @return [String] the IPv4 address in its text representation.
-    #
     def_delegator :value, :to_s
 
-    #
     # @return [Number] the IPv4 address in its numeric representation.
-    #
     def_delegator :value, :to_i
 
-    #
     # @return [Range] Creates a Range object for the network address.
-    #
     def_delegator :value, :to_range
 
     def_delegator :value, :==
 
-    #
     # @return [Number] prefix length of IPv4 address.
-    #
     def prefixlen
       netmask = to_range.first.to_i ^ to_range.last.to_i
       if netmask > 0
@@ -70,88 +56,68 @@ module Pio
       end
     end
 
-    #
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
-    #
     def to_a
       to_s.split('.').map do | each |
         each.to_i
       end
     end
 
-    #
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
-    #
     def to_ary
       to_a
     end
 
-    #
+    # Returns the IPv4 address masked with +masklen+.
     # @return [IPv4Address]
-    #   Returns the IPv4 address masked with masklen.
-    #
     def mask!(masklen)
       @value = @value.mask(masklen)
       self
     end
     alias_method :prefix!, :mask!
 
-    #
+    # Returns the IPv4 address masked with +masklen+.
     # @return [IPv4Address]
-    #   Returns the IPv4 address masked with masklen.
-    #
     def mask(masklen)
       clone.mask!(masklen)
     end
     alias_method :prefix, :mask
 
-    #
     # @return [bool]
     #   Returns true if the address belongs to class A.
-    #
     def class_a?
       mask(1).to_s == '0.0.0.0'
     end
 
-    #
     # @return [bool]
     #   Returns true if the address belongs to class B.
-    #
     def class_b?
       mask(2).to_s == '128.0.0.0'
     end
 
-    #
     # @return [bool]
     #   Returns true if the address belongs to class C.
-    #
     def class_c?
       mask(3).to_s == '192.0.0.0'
     end
 
-    #
     # @return [bool]
     #   Returns true if the address belongs to class D.
-    #
     def class_d?
       mask(4).to_s == '224.0.0.0'
     end
     alias_method :multicast?, :class_d?
 
-    #
     # @return [bool]
     #   Returns true if the address belongs to class E.
-    #
     def class_e?
       mask(4).to_s == '240.0.0.0'
     end
 
-    #
     # @return [bool]
     #   Returns true if the address is unicast address.
-    #
     def unicast?
       class_a? || class_b? || class_c?
     end

data/lib/pio/pcap.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  # .pcap file parser
+  module Pcap
+    BIG_ENDIAN = 0xa1b2c3d4
+    LITTLE_ENDIAN = 0xd4c3b2a1
+
+    LINKTYPE_ETHERNET = 1
+
+    # Big or little endian?
+    # This code smells of :reek:UncommunicativeModuleName
+    class EndianMagicNumber16 < BinData::Choice
+      int16be BIG_ENDIAN, initial_value: :value
+      int16le LITTLE_ENDIAN, initial_value: :value
+    end
+
+    # Big or little endian?
+    # This code smells of :reek:UncommunicativeModuleName
+    class EndianMagicNumber32 < BinData::Choice
+      int32be BIG_ENDIAN, initial_value: :value
+      int32le LITTLE_ENDIAN, initial_value: :value
+    end
+
+    # .pcap format
+    class Frame < BinData::Record
+      byte_order = -> { file_header.magic }
+
+      struct :file_header do
+        hide :thiszone, :sigfigs
+
+        uint32be :magic,
+                 initial_value: 0xa1b2c3d4,
+                 assert: -> { value == BIG_ENDIAN || value == LITTLE_ENDIAN }
+        endian_magic_number16 :version_major, value: 2, selection: byte_order
+        endian_magic_number16 :version_minor, value: 4, selection: byte_order
+        endian_magic_number32 :thiszone, value: 0, selection: byte_order
+        endian_magic_number32 :sigfigs, value: 0, selection: byte_order
+        endian_magic_number32 :snaplen, value: 65_535, selection: byte_order
+        endian_magic_number32 :linktype,
+                              value: LINKTYPE_ETHERNET,
+                              selection: byte_order
+      end
+
+      array :records, read_until: :eof do
+        struct :pkthdr do
+          struct :ts do
+            endian_magic_number32 :sec, value: 0, selection: byte_order
+            endian_magic_number32 :usec, value: 0, selection: byte_order
+          end
+          endian_magic_number32 :caplen,
+                                value: -> { data.length },
+                                selection: byte_order
+          endian_magic_number32 :len,
+                                value: -> { data.length },
+                                selection: byte_order
+        end
+        string :data, read_length: -> { pkthdr.caplen }
+      end
+    end
+  end
+end

data/lib/pio/version.rb

@@ -3,5 +3,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/pio.gemspec

@@ -24,8 +24,15 @@ Gem::Specification.new do |gem|
 
   gem.require_paths = ['lib']
 
-  gem.extra_rdoc_files = ['README.md']
+  gem.extra_rdoc_files =
+    [
+      'README.md',
+      'CHANGELOG.md',
+      'LICENSE',
+      'CONTRIBUTING.md'
+    ]
   gem.test_files = Dir.glob('spec/**/*')
+  gem.test_files += Dir.glob('features/**/*')
 
   gem.required_ruby_version = '>= 1.9.3'
   gem.add_dependency 'bindata', '~> 2.0.0'

data/spec/pio/hello_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Hello do
+  describe '.read' do
+    context 'with an hello message' do
+      Given(:hello_dump) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      When(:hello) { Pio::Hello.read(hello_dump) }
+
+      Then { hello.class == Pio::Hello }
+      Then { hello.version == 1 }
+      Then { hello.message_type == 0 }
+      Then { hello.message_length == 8 }
+      Then { hello.xid == 0 }
+      Then { hello.body.empty? }
+    end
+  end
+
+  describe '.new' do
+    context 'with no arguments' do
+      When(:hello) { Pio::Hello.new }
+
+      Then { hello.class == Pio::Hello }
+      Then { hello.version == 1 }
+      Then { hello.message_type == 0 }
+      Then { hello.message_length == 8 }
+      Then { hello.xid == 0 }
+      Then { hello.body.empty? }
+      Then { hello.to_binary == [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with transaction_id: 123' do
+      When(:hello) { Pio::Hello.new(transaction_id: 123) }
+
+      Then { hello.class == Pio::Hello }
+      Then { hello.version == 1 }
+      Then { hello.message_type == 0 }
+      Then { hello.message_length == 8 }
+      Then { hello.xid == 123 }
+      Then { hello.body.empty? }
+      Then { hello.to_binary == [1, 0, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with xid: 123' do
+      When(:hello) { Pio::Hello.new(xid: 123) }
+
+      Then { hello.class == Pio::Hello }
+      Then { hello.version == 1 }
+      Then { hello.message_type == 0 }
+      Then { hello.message_length == 8 }
+      Then { hello.xid == 123 }
+      Then { hello.body.empty? }
+      Then { hello.to_binary == [1, 0, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pio
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -45,7 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
+- LICENSE
+- CONTRIBUTING.md
 files:
+- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE
 - README.md
@@ -54,10 +58,24 @@ files:
 - examples/arp_read.rb
 - examples/dhcp_new.rb
 - examples/dhcp_read.rb
+- examples/hello_new.rb
+- examples/hello_read.rb
 - examples/icmp_new.rb
 - examples/icmp_read.rb
 - examples/lldp_new.rb
 - examples/lldp_read.rb
+- features/arp_read.feature
+- features/dhcp_read.feature
+- features/icmp_read.feature
+- features/lldp_read.feature
+- features/pcap/arp-storm.pcap
+- features/pcap/arp.pcap
+- features/pcap/dhcp.pcap
+- features/pcap/icmp.pcap
+- features/pcap/lldp.detailed.pcap
+- features/pcap/lldp.minimal.pcap
+- features/step_definitions/pcap_steps.rb
+- features/support/env.rb
 - lib/pio.rb
 - lib/pio/arp.rb
 - lib/pio/arp/frame.rb
@@ -70,6 +88,7 @@ files:
 - lib/pio/dhcp/boot_reply_options.rb
 - lib/pio/dhcp/boot_request.rb
 - lib/pio/dhcp/boot_request_options.rb
+- lib/pio/dhcp/client_id.rb
 - lib/pio/dhcp/common_options.rb
 - lib/pio/dhcp/csum_util.rb
 - lib/pio/dhcp/dhcp_field.rb
@@ -80,10 +99,10 @@ files:
 - lib/pio/dhcp/message.rb
 - lib/pio/dhcp/offer.rb
 - lib/pio/dhcp/optional_tlv.rb
+- lib/pio/dhcp/parameter_list.rb
 - lib/pio/dhcp/request.rb
-- lib/pio/dhcp/type/dhcp_client_id.rb
-- lib/pio/dhcp/type/dhcp_param_list.rb
-- lib/pio/dhcp/type/dhcp_string.rb
+- lib/pio/hello.rb
+- lib/pio/hello/format.rb
 - lib/pio/icmp.rb
 - lib/pio/icmp/frame.rb
 - lib/pio/icmp/message.rb
@@ -109,6 +128,7 @@ files:
 - lib/pio/message_type_selector.rb
 - lib/pio/options.rb
 - lib/pio/parse_error.rb
+- lib/pio/pcap.rb
 - lib/pio/type/ethernet_header.rb
 - lib/pio/type/ip_address.rb
 - lib/pio/type/ipv4_header.rb
@@ -126,6 +146,7 @@ files:
 - spec/pio/dhcp/offer_spec.rb
 - spec/pio/dhcp/request_spec.rb
 - spec/pio/dhcp_spec.rb
+- spec/pio/hello_spec.rb
 - spec/pio/icmp/reply_spec.rb
 - spec/pio/icmp/request_spec.rb
 - spec/pio/icmp_spec.rb
@@ -159,22 +180,35 @@ signing_key:
 specification_version: 4
 summary: Packet parser and generator.
 test_files:
-- spec/pio/arp/reply/options_spec.rb
-- spec/pio/arp/reply_spec.rb
-- spec/pio/arp/request/options_spec.rb
-- spec/pio/arp/request_spec.rb
-- spec/pio/arp_spec.rb
+- spec/pio/ipv4_address_spec.rb
+- spec/pio/hello_spec.rb
+- spec/pio/dhcp/request_spec.rb
+- spec/pio/dhcp/offer_spec.rb
 - spec/pio/dhcp/ack_spec.rb
 - spec/pio/dhcp/discover_spec.rb
-- spec/pio/dhcp/offer_spec.rb
-- spec/pio/dhcp/request_spec.rb
-- spec/pio/dhcp_spec.rb
-- spec/pio/icmp/reply_spec.rb
+- spec/pio/arp/request_spec.rb
+- spec/pio/arp/reply/options_spec.rb
+- spec/pio/arp/request/options_spec.rb
+- spec/pio/arp/reply_spec.rb
+- spec/pio/lldp/options_spec.rb
+- spec/pio/mac_spec.rb
 - spec/pio/icmp/request_spec.rb
+- spec/pio/icmp/reply_spec.rb
 - spec/pio/icmp_spec.rb
-- spec/pio/ipv4_address_spec.rb
-- spec/pio/lldp/options_spec.rb
+- spec/pio/dhcp_spec.rb
 - spec/pio/lldp_spec.rb
-- spec/pio/mac_spec.rb
+- spec/pio/arp_spec.rb
 - spec/spec_helper.rb
+- features/pcap/dhcp.pcap
+- features/pcap/arp.pcap
+- features/pcap/lldp.minimal.pcap
+- features/pcap/icmp.pcap
+- features/pcap/arp-storm.pcap
+- features/pcap/lldp.detailed.pcap
+- features/support/env.rb
+- features/icmp_read.feature
+- features/arp_read.feature
+- features/step_definitions/pcap_steps.rb
+- features/lldp_read.feature
+- features/dhcp_read.feature
 has_rdoc: 

data/lib/pio/dhcp/type/dhcp_string.rb

@@ -1,21 +0,0 @@
-# encoding: utf-8
-
-require 'bindata'
-
-module Pio
-  module Type
-    # DHCP String Format.
-    class DhcpString < BinData::Primitive
-      string :dhcp_string,
-             read_length: :tlv_info_length
-
-      def set(value)
-        self.dhcp_string = value
-      end
-
-      def get
-        dhcp_string
-      end
-    end
-  end
-end