pio 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f75df3f4f4091dda09de3b77789eea400df989dc
-  data.tar.gz: 1cc6ef0de733c14e84efe1fff569ed7de0943c03
+  metadata.gz: 399c1ee151a9c001cf2f626ae5cb9f20554664f6
+  data.tar.gz: 5aa7d55d32839bb91f762b1a601c20a72b4da882
 SHA512:
-  metadata.gz: 19d72385b493052449cd2de18df8bed3a6385fb452ffc52883f6b9f781b09c9807596869920d59fce09dc812e5f9d9434be249f27389095ce650655b69e1d7e2
-  data.tar.gz: 6862a78e369025dc34d89086a8f10cf4fd7ca19dbdea867de0d583350cb4fd9c937f4cef1bb09117e87912d5d747ec4c5deeb8c9f5bfafccb87c155d079baaa3
+  metadata.gz: 0f990c0cf9aef24a57f1c04a67f8134e1b6972dca1e0573f6274c9adeebddf5768f38266ad60a7766707ff6560cc031696a6ee1b6187794ec3d56374f3b33c61
+  data.tar.gz: b82319079f8387ef3c52d457bb4f69aff2cb2a34e2b3dcc04e9546534cc5d1ec0f690d162c99ff2a78dada0de47e19815abd8da40274fa0259274d98bd0cef39

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 ## develop (unreleased)
 
 
+## 0.16.0 (3/2/2015)
+### New features
+* [#129](https://github.com/trema/pio/pull/129): Add new class `Pio::Udp`.
+
+
 ## 0.15.2 (2/18/2015)
 ### Changes
 * [#128](https://github.com/trema/pio/pull/128): Field accessors return Ruby primitives (Fixnum, Symbol, etc.).

data/features/dhcp_read.feature

@@ -1,3 +1,4 @@
+@announce
 Feature: Pio::Dhcp.read
   Scenario: dhcp.pcap
     Given a packet data file "dhcp.pcap"

data/features/icmp_read.feature

@@ -3,3 +3,53 @@ Feature: Pio::Icmp.read
     Given a packet data file "icmp.pcap"
     When I try to parse the file with "Icmp" class
     Then it should finish successfully
+    And the parsed data #1 have the following field and value:
+    | field                  |                            value |
+    | class                  |               Pio::Icmp::Request |
+    | destination_mac        |                00:13:46:0b:22:ba |
+    | source_mac             |                00:16:ce:6e:8b:24 |
+    | ether_type             |                             2048 |
+    | ip_version             |                                4 |
+    | ip_header_length       |                                5 |
+    | ip_type_of_service     |                                0 |
+    | ip_total_length        |                               60 |
+    | ip_identifier          |                            36507 |
+    | ip_flag                |                                0 |
+    | ip_fragment            |                                0 |
+    | ip_ttl                 |                              128 |
+    | ip_protocol            |                                1 |
+    | ip_header_checksum     |                            10850 |
+    | ip_source_address      |                    192.168.0.114 |
+    | ip_destination_address |                      192.168.0.1 |
+    | ip_option              |                                  |
+    | icmp_type              |                                8 |
+    | icmp_code              |                                0 |
+    | icmp_checksum          |                            18780 |
+    | icmp_identifier        |                              768 |
+    | icmp_sequence_number   |                              256 |
+    | echo_data              | abcdefghijklmnopqrstuvwabcdefghi |
+    And the parsed data #2 have the following field and value:
+    | field                  |                            value |
+    | class                  |                 Pio::Icmp::Reply |
+    | destination_mac        |                00:16:ce:6e:8b:24 |
+    | source_mac             |                00:13:46:0b:22:ba |
+    | ether_type             |                             2048 |
+    | ip_version             |                                4 |
+    | ip_header_length       |                                5 |
+    | ip_type_of_service     |                                0 |
+    | ip_total_length        |                               60 |
+    | ip_identifier          |                            24150 |
+    | ip_flag                |                                0 |
+    | ip_fragment            |                                0 |
+    | ip_ttl                 |                              127 |
+    | ip_protocol            |                                1 |
+    | ip_header_checksum     |                            23463 |
+    | ip_source_address      |                      192.168.0.1 |
+    | ip_destination_address |                    192.168.0.114 |
+    | ip_option              |                                  |
+    | icmp_type              |                                0 |
+    | icmp_code              |                                0 |
+    | icmp_checksum          |                            20828 |
+    | icmp_identifier        |                              768 |
+    | icmp_sequence_number   |                              256 |
+    | echo_data              | abcdefghijklmnopqrstuvwabcdefghi |

data/features/step_definitions/packet_data_steps.rb

@@ -17,8 +17,11 @@ When(/^I try to parse the file with "(.*?)" class$/) do |parser|
     @result = parser_klass.read(IO.read(@raw))
   elsif @pcap
     File.open(@pcap) do |file|
+      @result = []
       pcap = Pio::Pcap::Frame.read(file)
-      pcap.records.each { |each| parser_klass.read each.data }
+      pcap.records.each do |each|
+        @result << parser_klass.read(each.data)
+      end
     end
   else
     fail 'Packet data file is not specified.'
@@ -41,3 +44,14 @@ Then(/^the parsed data have the following field and value:$/) do |table|
     expect(output.to_s).to eq(each['value'])
   end
 end
+
+# rubocop:disable LineLength
+Then(/^the parsed data \#(\d+) have the following field and value:$/) do |index, table|
+  table.hashes.each do |each|
+    output = each['field'].split('.').inject(@result[index.to_i - 1]) do |memo, method|
+      memo.__send__(method)
+    end
+    expect(output.to_s).to eq(each['value'])
+  end
+end
+# rubocop:enable LineLength

data/features/udp_read.feature

@@ -0,0 +1,29 @@
+Feature: Pio::Udp.read
+  Scenario: dhcp.pcap
+    Given a packet data file "dhcp.pcap"
+    When I try to parse the file with "Udp" class
+    Then it should finish successfully
+    And the parsed data #1 have the following field and value:
+    | field                  |             value |
+    | class                  |          Pio::Udp |
+    | destination_mac        | ff:ff:ff:ff:ff:ff |
+    | source_mac             | 00:0b:82:01:fc:42 |
+    | ether_type             |              2048 |
+    | ip_version             |                 4 |
+    | ip_header_length       |                 5 |
+    | ip_type_of_service     |                 0 |
+    | ip_total_length        |               300 |
+    | ip_identifier          |             43062 |
+    | ip_flag                |                 0 |
+    | ip_fragment            |                 0 |
+    | ip_ttl                 |               250 |
+    | ip_protocol            |                17 |
+    | ip_header_checksum     |              6027 |
+    | ip_source_address      |           0.0.0.0 |
+    | ip_destination_address |   255.255.255.255 |
+    | ip_option              |                   |
+    | udp_source_port        |                68 |
+    | udp_destination_port   |                67 |
+    | udp_length             |               280 |
+    | udp_checksum           |             22815 |
+    | udp_payload.length     |               272 |

data/lib/pio.rb

@@ -13,3 +13,4 @@ require 'pio/mac'
 require 'pio/packet_in'
 require 'pio/packet_out'
 require 'pio/port_status'
+require 'pio/udp'

data/lib/pio/arp/format.rb

@@ -1,5 +1,5 @@
 require 'bindata'
-require 'pio/type/ethernet_header'
+require 'pio/ethernet_header'
 require 'pio/type/ip_address'
 require 'pio/type/mac_address'
 
@@ -7,7 +7,7 @@ module Pio
   class Arp
     # ARP parser.
     class Format < BinData::Record
-      extend Type::EthernetHeader
+      include EthernetHeader
 
       endian :big
 

data/lib/pio/dhcp/boot_reply_options.rb

@@ -31,8 +31,8 @@ module Pio
           source_mac: source_mac,
           ip_destination_address: ip_destination_address,
           ip_source_address: ip_source_address,
-          udp_src_port: BOOTPS,
-          udp_dst_port: BOOTPC,
+          udp_source_port: BOOTPS,
+          udp_destination_port: BOOTPC,
           dhcp: dhcp_data
         }
       end

data/lib/pio/dhcp/boot_request_options.rb

@@ -27,8 +27,8 @@ module Pio
           source_mac: source_mac,
           ip_source_address: QUAD_ZERO_IP_ADDRESS,
           ip_destination_address: BROADCAST_IP_ADDRESS,
-          udp_src_port: BOOTPC,
-          udp_dst_port: BOOTPS,
+          udp_source_port: BOOTPC,
+          udp_destination_port: BOOTPS,
           dhcp: dhcp_data
         }
       end

data/lib/pio/dhcp/frame.rb

@@ -1,92 +1,37 @@
-require 'pio/type/ethernet_header'
-require 'pio/type/ipv4_header'
-require 'pio/type/udp_header'
 require 'pio/dhcp/dhcp_field'
 require 'pio/dhcp/field_util'
-require 'pio/dhcp/csum_util'
+require 'pio/ipv4_header'
+require 'pio/ethernet_header'
+require 'pio/udp_header'
 
 module Pio
   class Dhcp
     # Dhcp frame parser.
     class Frame < BinData::Record
-      extend Type::EthernetHeader
-      extend Type::IPv4Header
-      extend Type::UdpHeader
       include FieldUtil
-      include CsumUtil
 
-      ETHER_TYPE_IP = 0x0800
-      IP_PROTOCOL_UDP = 17
-      IP_HEADER_LENGTH = 20
-      UDP_HEADER_LENGTH = 8
-      DHCP_OPTION_FIELD_LENGTH = 60
+      OPTION_FIELD_LENGTH = 60
 
-      endian :big
+      include EthernetHeader
+      include IPv4Header
+      include UdpHeader
 
-      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 }
+      endian :big
+      ethernet_header ether_type: EthernetHeader::ETHER_TYPE_IP
+      ipv4_header ip_protocol: IPv4Header::IP_PROTOCOL_UDP
+      udp_header
       dhcp_field :dhcp
-
-      def ip_sum
-        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
-      end
-
-      def udp_sum
-        ~((udp_csum & 0xffff) + (udp_csum >> 16)) & 0xffff
-      end
-
-      def ip_len
-        IP_HEADER_LENGTH + udp_len
-      end
-
-      def udp_len
-        UDP_HEADER_LENGTH + dhcp_len
-      end
+      string :padding, read_length: 0, initial_value: :ff_and_padding
 
       def to_binary
-        to_binary_s + trail_data
+        to_binary_s
       end
 
       private
 
-      def dhcp_len
-        dhcp.num_bytes + trail_data.bytesize
-      end
-
-      def dhcp_binary
-        dhcp.to_binary_s
-      end
-
-      def should_padding?
-        option_length < DHCP_OPTION_FIELD_LENGTH
-      end
-
-      def option_length
-        dhcp.optional_tlvs.num_bytes + 1
-      end
-
-      def trail_data
-        if should_padding?
-          end_of_pdu + padding
-        else
-          end_of_pdu
-        end
-      end
-
-      def end_of_pdu
-        [0xff].pack('C*')
-      end
-
-      def padding
-        [0x00].pack('C*') * padding_length
-      end
-
-      def padding_length
-        DHCP_OPTION_FIELD_LENGTH - option_length
+      def ff_and_padding
+        padding_length = OPTION_FIELD_LENGTH - dhcp.optional_tlvs.num_bytes - 1
+        "\xFF" + (padding_length > 0 ? "\x00" * padding_length : '')
       end
     end
   end

data/lib/pio/dhcp/message.rb

@@ -22,8 +22,8 @@ module Pio
       def_delegators :@frame, :ip_header_checksum
       def_delegators :@frame, :ip_source_address
       def_delegators :@frame, :ip_destination_address
-      def_delegators :@frame, :udp_src_port
-      def_delegators :@frame, :udp_dst_port
+      def_delegators :@frame, :udp_source_port
+      def_delegators :@frame, :udp_destination_port
       def_delegators :@frame, :udp_length
       def_delegators :@frame, :udp_checksum
       def_delegators :@frame, :dhcp

data/lib/pio/ethernet_header.rb

@@ -0,0 +1,40 @@
+require 'pio/type/mac_address'
+
+# Base module
+module Pio
+  # Adds ethernet_header macro.
+  module EthernetHeader
+    ETHER_TYPE_IP = 0x0800
+
+    # rubocop:disable AbcSize
+    def self.included(klass)
+      def klass.ethernet_header(options = {})
+        mac_address :destination_mac
+        mac_address :source_mac
+        uint16 :ether_type_internal, initial_value: options[:ether_type] || 0
+        bit3 :vlan_pcp_internal, onlyif: -> { vlan? }
+        bit1 :vlan_cfi, onlyif: -> { vlan? }
+        bit12 :vlan_vid_internal, onlyif: -> { vlan? }
+        uint16 :ether_type_vlan,
+               onlyif: -> { vlan? }, initial_value: options[:ether_type] || 0
+      end
+    end
+    # rubocop:enable AbcSize
+
+    def ether_type
+      ether_type_internal
+    end
+
+    def vlan_vid
+      vlan? ? vlan_vid_internal : 0xffff
+    end
+
+    def vlan_pcp
+      vlan? ? vlan_pcp_internal : 0
+    end
+
+    def vlan?
+      ether_type == 0x8100
+    end
+  end
+end

data/lib/pio/exact_match.rb

@@ -1,5 +1,4 @@
 require 'pio/match'
-require 'pio/type/ethernet_header'
 
 module Pio
   # OpenFlow 1.0 exact match

data/lib/pio/icmp/format.rb

@@ -1,126 +1,52 @@
 require 'bindata'
-require 'pio/type/ethernet_header'
-require 'pio/type/ipv4_header'
+require 'pio/ethernet_header'
+require 'pio/ipv4_header'
 
 module Pio
   class Icmp
     # Icmp parser.
     class Format < BinData::Record
-      PADDED_PACKET_LENGTH = 50
-      MINIMUM_PACKET_LENGTH = 36
-      MINIMUM_FRAME_LENGTH = 64
+      MINIMUM_IP_PACKET_LENGTH = 50
 
-      extend Type::EthernetHeader
-      extend Type::IPv4Header
+      include EthernetHeader
+      include IPv4Header
 
       endian :big
 
-      ethernet_header ether_type: 0x0800
-      ipv4_header ip_protocol: 1,
-                  ip_header_checksum: -> { ip_sum },
-                  ip_total_length: -> { ip_packet_length }
+      ethernet_header ether_type: EthernetHeader::ETHER_TYPE_IP
+      ipv4_header ip_protocol: IPv4Header::IP_PROTOCOL_ICMP
       uint8 :icmp_type
       uint8 :icmp_code, initial_value: 0
-      uint16 :icmp_checksum, value: -> { icmp_sum }
+      uint16 :icmp_checksum, value: :calculate_icmp_checksum
       uint16 :icmp_identifier
       uint16 :icmp_sequence_number
-      string :echo_data,
-             read_length: -> { echo_data_length }
+      string :echo_data, read_length: :echo_data_read_length
+      string :padding, read_length: 0, initial_value: :icmp_padding_length
 
       def message_type
         icmp_type
       end
 
-      def echo_data_length
-        ip_total_length - (ip_header_length * 4 + 8)
-      end
-
-      def ip_packet_length
-        icmpsize = (ip_header_length * 4) + (8 + echo_data.bytesize)
-        if icmpsize < MINIMUM_PACKET_LENGTH
-          PADDED_PACKET_LENGTH
-        else
-          icmpsize
-        end
-      end
-
-      def icmp_sum
-        ~((icmp_csum & 0xffff) + (icmp_csum >> 16)) & 0xffff
-      end
-
-      def ip_sum
-        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
-      end
-
-      def to_binary
-        if num_bytes < MINIMUM_FRAME_LENGTH
-          to_binary_s + "\000" * (MINIMUM_FRAME_LENGTH - num_bytes)
-        else
-          to_binary_s
-        end
-      end
+      alias_method :to_binary, :to_binary_s
 
       private
 
-      def icmp_csum
-        icmp_2bytewise_slices.reduce(0) do |acc, each|
-          acc + each
-        end
-      end
-
-      def ip_csum
-        ipv4_header_2bytewise_slices.reduce(0) do |acc, each|
-          acc + each
-        end
-      end
-
-      def icmp_2bytewise_slices
-        [
-          icmp_type * 0x100 + icmp_code,
-          icmp_identifier,
-          icmp_sequence_number,
-          *echo_data.unpack('n*')
-        ]
-      end
-
-      def ipv4_header_2bytewise_slices
-        [
-          ipversion_ipheaderlength_iptypeofservice, ip_total_length,
-          ip_identifier, ipflag_ipfragment,
-          ipttl_ipproto,
-          ip_source_address_upper,
-          ip_source_address_lower,
-          ip_destination_address_upper,
-          ip_destination_address_lower
-        ]
-      end
-
-      def ip_source_address_upper
-        ip_source_address.get.to_i >> 16
-      end
-
-      def ip_source_address_lower
-        ip_source_address.get.to_i & 0xffff
-      end
-
-      def ip_destination_address_upper
-        ip_destination_address.get.to_i >> 16
-      end
-
-      def ip_destination_address_lower
-        ip_destination_address.get.to_i & 0xffff
-      end
-
-      def ipversion_ipheaderlength_iptypeofservice
-        ip_version << 12 | ip_header_length << 8 | ip_type_of_service
+      def calculate_icmp_checksum
+        sum = [icmp_type * 0x100 + icmp_code,
+               icmp_identifier,
+               icmp_sequence_number,
+               *echo_data.unpack('n*')].inject(:+)
+        ~((sum & 0xffff) + (sum >> 16)) & 0xffff
       end
 
-      def ipflag_ipfragment
-        ip_flag << 13 | ip_fragment
+      def echo_data_read_length
+        ip_total_length - (ip_header_length * 4) - 8
       end
 
-      def ipttl_ipproto
-        ip_ttl << 8 | ip_protocol
+      def icmp_padding_length
+        length = MINIMUM_IP_PACKET_LENGTH -
+                 (ip_header_length * 4) - 8 - echo_data.length
+        length > 0 ? "\x00" * length : ''
       end
     end
   end