pio 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24250e762b41db6e78d190ece32de1a57bbba89c
-  data.tar.gz: df8706edd1b12d95750bb240b21ea93021b09d1d
+  metadata.gz: 9f5e9be92c12989ecc7bfe94c76a5db47bb5304e
+  data.tar.gz: dc6414ddb0c09cc48489295b5d4c746cfda522e9
 SHA512:
-  metadata.gz: 008fe84cace5c6050f941180a8122dbcfbcdb475936efef993002dc33b6f939149d000c7d5955c9396defaef49a6e6a85e6d6c5f1ca460fa50b772e8ed5ae182
-  data.tar.gz: af12f5c7bca4549a0c2ce34531def8ece2d530b88ef091763f84c782d0fbaa5c8081936982c074325391e4bed7d43b22b7b014362e6a9f72ac76ae04e2b95f2d
+  metadata.gz: a5b3da4c83662a1d20002dde48e926c71becb41f22c8efc4151a7966dcc75566333c17cb9d6f14805741d521914bc98caf97c940c7add564a7fb676aec876ed9
+  data.tar.gz: 081cc576cb1481899bd8733462e914f7644ccd1e51138bece41ff93851f432c63c6c56f4872519d297366b9e8c1524d237d40eaeff06f3cd8ab27a92b4df1bac

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.7.0 (4/22/2014)
+
+### New features
+* Added new class `Pio::Features`, `Pio::Features::Request` and `Pio::Features::Reply`
+
+### Changes
+* Renamed `rake PCAP='foo.pcap' dump_pcap` => `rake PACKET_FILE='foo.pcap' dump`
+
+
 ## 0.6.0 (4/15/2014)
 
 ### New features

data/README.md

@@ -18,7 +18,8 @@ supports the following packet formats:
 -   DHCP
 -   OpenFlow 1.0
     -   Hello
-    -   Echo Request and Reply
+    -   Echo
+    -   Features
 -   (…currently there are just a few formats supported but I'm sure this list will grow)
 
 ## Features Overview
@@ -132,33 +133,37 @@ Also you can use `Pio::Dhcp::Discover#new`,
 
     require 'pio'
 
-    discover = Pio::Dhcp::Discover.new(source_mac: '24:db:ac:41:e5:5b')
+    dhcp_client_mac_address = '24:db:ac:41:e5:5b'
+
+    dhcp_server_options =
+      {
+        source_mac: '00:26:82:eb:ea:d1',
+        destination_mac: '24:db:ac:41:e5:5b',
+        ip_source_address: '192.168.0.100',
+        ip_destination_address: '192.168.0.1'
+      }
+
+    # Client side
+    discover = Pio::Dhcp::Discover.new(source_mac: dhcp_client_mac_address)
     discover.to_binary  # => DHCP Discover frame in binary format
 
-    offer = Pio::Dhcp::Offer.new(
-      source_mac: '00:26:82:eb:ea:d1',
-      destination_mac: '24:db:ac:41:e5:5b',
-      ip_source_address: '192.168.0.100',
-      ip_destination_address: '192.168.0.1',
-      transaction_id: discover.transaction_id
-    )
+    # Server side
+    offer = Pio::Dhcp::Offer.new(dhcp_server_options
+                                 .merge(transaction_id: discover.transaction_id))
     offer.to_binary  # => DHCP Offer frame in binary format
 
+    # Client side
     request = Pio::Dhcp::Request.new(
-      source_mac: '24:db:ac:41:e5:5b',
-      server_identifier: '192.168.0.100',
-      requested_ip_address: '192.168.0.1',
+      source_mac: dhcp_client_mac_address,
+      server_identifier: dhcp_server_options[:ip_source_address],
+      requested_ip_address: dhcp_server_options[:ip_destination_address],
       transaction_id: offer.transaction_id
     )
     request.to_binary  # => DHCP Request frame in binary format
 
-    ack = Pio::Dhcp::Ack.new(
-      source_mac: '00:26:82:eb:ea:d1',
-      destination_mac: '24:db:ac:41:e5:5b',
-      ip_source_address: '192.168.0.100',
-      ip_destination_address: '192.168.0.1',
-      transaction_id: request.transaction_id
-    )
+    # Server side
+    ack = Pio::Dhcp::Ack.new(dhcp_server_options
+                             .merge(transaction_id: request.transaction_id))
     ack.to_binary  # => DHCP Ack frame in binary format
 
 ### Hello
@@ -179,10 +184,10 @@ below:
     hello = Pio::Hello.new(transaction_id: 123)
     hello.to_binary  # => HELLO message in binary format.
 
-## Echo
+### Echo
 
-To parse an OpenFlow 1.0 ECHO message, use the API `Pio::Echo.read`
-and you can access each field of the parsed ECHO message.
+To parse an OpenFlow 1.0 Echo message, use the API `Pio::Echo.read`
+and you can access each field of the parsed Echo message.
 
     require 'pio'
 
@@ -202,6 +207,35 @@ generate an Echo Request/Reply message like below:
     reply = Pio::Echo::Reply.new(xid: request.xid)
     reply.to_binary  # => ECHO Reply message in binary format.
 
+### Features
+
+To parse an OpenFlow 1.0 Features message, use the API
+`Pio::Features.read` and you can access each field of the parsed
+Features message.
+
+    require 'pio'
+
+    features = Pio::Features.read(binary_data)
+    features.xid # => 123
+
+Also you can use `Pio::Features::Request#new` or `Pio::Features::Reply#new` to
+generate an Features Request/Reply message like below:
+
+    require 'pio'
+
+    request = Pio::Features::Request.new
+    request.to_binary  # => Features Request message in binary format.
+
+    # The Features xid (transaction_id)
+    # should be same as that of the request.
+    reply = Pio::Features::Reply.new(xid: request.xid,
+                                     dpid: 0x123,
+                                     n_buffers: 0x100,
+                                     n_tables: 0xfe,
+                                     capabilities: 0xc7,
+                                     actions: 0xfff)
+    reply.to_binary  # => Features Reply message in binary format.
+
 ## Installation
 
 The simplest way to install Pio is to use [Bundler](http://gembundler.com/).

data/examples/dhcp_new.rb

@@ -1,30 +1,34 @@
 require 'pio'
 
-discover = Pio::Dhcp::Discover.new(source_mac: '24:db:ac:41:e5:5b')
+dhcp_client_mac_address = '24:db:ac:41:e5:5b'
+
+dhcp_server_options =
+  {
+    source_mac: '00:26:82:eb:ea:d1',
+    destination_mac: '24:db:ac:41:e5:5b',
+    ip_source_address: '192.168.0.100',
+    ip_destination_address: '192.168.0.1'
+  }
+
+# Client side
+discover = Pio::Dhcp::Discover.new(source_mac: dhcp_client_mac_address)
 discover.to_binary  # => DHCP Discover frame in binary format
 
-offer = Pio::Dhcp::Offer.new(
-  source_mac: '00:26:82:eb:ea:d1',
-  destination_mac: '24:db:ac:41:e5:5b',
-  ip_source_address: '192.168.0.100',
-  ip_destination_address: '192.168.0.1',
-  transaction_id: discover.transaction_id
-)
+# Server side
+offer = Pio::Dhcp::Offer.new(dhcp_server_options
+                             .merge(transaction_id: discover.transaction_id))
 offer.to_binary  # => DHCP Offer frame in binary format
 
+# Client side
 request = Pio::Dhcp::Request.new(
-  source_mac: '24:db:ac:41:e5:5b',
-  server_identifier: '192.168.0.100',
-  requested_ip_address: '192.168.0.1',
+  source_mac: dhcp_client_mac_address,
+  server_identifier: dhcp_server_options[:ip_source_address],
+  requested_ip_address: dhcp_server_options[:ip_destination_address],
   transaction_id: offer.transaction_id
 )
 request.to_binary  # => DHCP Request frame in binary format
 
-ack = Pio::Dhcp::Ack.new(
-  source_mac: '00:26:82:eb:ea:d1',
-  destination_mac: '24:db:ac:41:e5:5b',
-  ip_source_address: '192.168.0.100',
-  ip_destination_address: '192.168.0.1',
-  transaction_id: request.transaction_id
-)
+# Server side
+ack = Pio::Dhcp::Ack.new(dhcp_server_options
+                         .merge(transaction_id: request.transaction_id))
 ack.to_binary  # => DHCP Ack frame in binary format

data/examples/features_new.rb

@@ -0,0 +1,14 @@
+require 'pio'
+
+request = Pio::Features::Request.new
+request.to_binary  # => Features Request message in binary format.
+
+# The Features xid (transaction_id)
+# should be same as that of the request.
+reply = Pio::Features::Reply.new(xid: request.xid,
+                                 dpid: 0x123,
+                                 n_buffers: 0x100,
+                                 n_tables: 0xfe,
+                                 capabilities: 0xc7,
+                                 actions: 0xfff)
+reply.to_binary  # => Features Reply message in binary format.

data/examples/features_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+features = Pio::Features.read(binary_data)
+features.xid # => 123

data/features/arp_read.feature

@@ -1,10 +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
+    Given a packet data file "arp.pcap"
+    When I try to parse the 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
+    Given a packet data file "arp-storm.pcap"
+    When I try to parse the file with "Arp" class
     Then it should finish successfully

data/features/dhcp_read.feature

@@ -1,5 +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
+    Given a packet data file "dhcp.pcap"
+    When I try to parse the file with "Dhcp" class
     Then it should finish successfully

data/features/echo_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::Echo.read
+  Scenario: echo.raw
+    Given a packet data file "echo.raw"
+    When I try to parse the file with "Echo" class
+    Then it should finish successfully

data/features/features_read.feature

@@ -0,0 +1,10 @@
+Feature: Pio::Features.read
+  Scenario: features_request.raw
+    Given a packet data file "features_request.raw"
+    When I try to parse the file with "Features" class
+    Then it should finish successfully
+
+  Scenario: features_reply.raw
+    Given a packet data file "features_reply.raw"
+    When I try to parse the file with "Features" class
+    Then it should finish successfully

data/features/hello_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::Hello.read
+  Scenario: hello.raw
+    Given a packet data file "hello.raw"
+    When I try to parse the file with "Hello" class
+    Then it should finish successfully

data/features/icmp_read.feature

@@ -1,5 +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
+    Given a packet data file "icmp.pcap"
+    When I try to parse the file with "Icmp" class
     Then it should finish successfully

data/features/lldp_read.feature

@@ -1,10 +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
+    Given a packet data file "lldp.minimal.pcap"
+    When I try to parse the 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
+    Given a packet data file "lldp.detailed.pcap"
+    When I try to parse the file with "Lldp" class
     Then it should finish successfully

data/features/step_definitions/packet_data_steps.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+Given(/^a packet data file "(.*?)"$/) do |name|
+  path = File.expand_path(File.join(File.dirname(__FILE__),
+                                    '..', 'packet_data', name))
+  case File.extname(name)
+  when '.raw'
+    @raw = path
+  when '.pcap'
+    @pcap = path
+  else
+    fail "Unsupported file extension: #{name}"
+  end
+end
+
+When(/^I try to parse the file with "(.*?)" class$/) do |parser|
+  parser_klass = Pio.const_get(parser)
+  if @raw
+    parser_klass.read IO.read(@raw)
+  elsif @pcap
+    File.open(@pcap) do |file|
+      pcap = Pio::Pcap::Frame.read(file)
+      pcap.records.each { |each| parser_klass.read each.data }
+    end
+  else
+    fail 'Packet data file is not specified.'
+  end
+end
+
+Then(/^it should finish successfully$/) do
+  # Noop.
+end

data/features/step_definitions/pending_steps.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+Given(/^PENDING/) do
+  pending
+end

data/lib/pio.rb

@@ -5,6 +5,7 @@ require 'pio/parse_error'
 require 'pio/arp'
 require 'pio/dhcp'
 require 'pio/echo'
+require 'pio/features'
 require 'pio/hello'
 require 'pio/icmp'
 require 'pio/lldp'

data/lib/pio/arp.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'pio/arp/frame'
+require 'pio/arp/format'
 require 'pio/arp/request'
 require 'pio/arp/reply'
 require 'pio/message_type_selector'

data/lib/pio/arp/{frame.rb → format.rb}

@@ -7,8 +7,8 @@ require 'pio/type/mac_address'
 
 module Pio
   class Arp
-    # ARP frame parser.
-    class Frame < BinData::Record
+    # ARP parser.
+    class Format < BinData::Record
       extend Type::EthernetHeader
 
       endian :big

data/lib/pio/arp/message.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 require 'forwardable'
-require 'pio/arp/frame'
+require 'pio/arp/format'
 
 module Pio
   class Arp
@@ -33,7 +33,7 @@ module Pio
 
       def initialize(user_options)
         options = self.class.const_get(:Options).new(user_options.dup.freeze)
-        @frame = Arp::Frame.new(options.to_hash)
+        @frame = Arp::Format.new(options.to_hash)
       end
     end
   end

data/lib/pio/dhcp/dhcp_field.rb

@@ -40,9 +40,9 @@ module Pio
              length: 128
       uint32be :magic_cookie,
                value: MAGIC_COOKIE
-      array  :optional_tlvs,
-             type: :optional_tlv,
-             read_until: -> { element.end_of_dhcptlv? }
+      array :optional_tlvs,
+            type: :optional_tlv,
+            read_until: -> { element.end_of_dhcptlv? }
     end
   end
 end

data/lib/pio/dhcp/frame.rb

@@ -26,12 +26,12 @@ module Pio
       endian :big
 
       ethernet_header ether_type: ETHER_TYPE_IP
-      ipv4_header     ip_protocol: IP_PROTOCOL_UDP,
-                      ip_header_checksum: -> { ip_sum },
-                      ip_total_length: -> { ip_len }
-      udp_header      udp_length: -> { udp_len },
-                      udp_checksum: -> { udp_sum }
-      dhcp_field      :dhcp
+      ipv4_header ip_protocol: IP_PROTOCOL_UDP,
+                  ip_header_checksum: -> { ip_sum },
+                  ip_total_length: -> { ip_len }
+      udp_header udp_length: -> { udp_len },
+                 udp_checksum: -> { udp_sum }
+      dhcp_field :dhcp
 
       def ip_sum
         ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff

data/lib/pio/dhcp/optional_tlv.rb

@@ -16,9 +16,9 @@ module Pio
       bit8 :tlv_type
       bit8 :tlv_info_length,
            onlyif: -> { !(end_of_dhcpdu?) }
-      choice  :tlv_value,
-              onlyif: -> { !(end_of_dhcpdu?) },
-              selection: :chooser do
+      choice :tlv_value,
+             onlyif: -> { !(end_of_dhcpdu?) },
+             selection: :chooser do
         uint8 Dhcp::MESSAGE_TYPE_TLV
         ip_address Dhcp::SERVER_IDENTIFIER_TLV
         uint32be Dhcp::RENEWAL_TIME_VALUE_TLV