pio 0.15.2 → 0.16.0

data/lib/pio/icmp/message.rb

@@ -1,41 +1,19 @@
 require 'pio/icmp/format'
-require 'forwardable'
 
 module Pio
   class Icmp
-    # Base class of Request, Reply, TTL Exceeded and destination unreachable.
+    # Base class of Icmp::Request and Icmp::Reply.
     class Message
-      extend Forwardable
-
-      def_delegators :@format, :destination_mac
-      def_delegators :@format, :source_mac
-      def_delegators :@format, :ether_type
-      def_delegators :@format, :ip_version
-      def_delegators :@format, :ip_header_length
-      def_delegators :@format, :ip_type_of_service
-      def_delegators :@format, :ip_total_length
-      def_delegators :@format, :ip_identifier
-      def_delegators :@format, :ip_flag
-      def_delegators :@format, :ip_fragment
-      def_delegators :@format, :ip_ttl
-      def_delegators :@format, :ip_protocol
-      def_delegators :@format, :ip_header_checksum
-      def_delegators :@format, :ip_source_address
-      def_delegators :@format, :ip_destination_address
-      def_delegators :@format, :icmp_type
-      def_delegators :@format, :icmp_code
-      def_delegators :@format, :icmp_checksum
-      def_delegators :@format, :icmp_identifier
-      def_delegators :@format, :icmp_sequence_number
-      def_delegators :@format, :echo_data
-      def_delegators :@format, :to_binary
-
       private_class_method :new
 
       def initialize(user_options)
         options = self.class.const_get(:Options).new(user_options)
         @format = Icmp::Format.new(options.to_hash)
       end
+
+      def method_missing(method, *args)
+        @format.__send__(method, *args)
+      end
     end
   end
 end

data/lib/pio/icmp/options.rb

@@ -4,8 +4,6 @@ module Pio
   class Icmp
     # User options for creating an ICMP messages.
     class Options < Pio::Options
-      DEFAULT_ECHO_DATA = ''.freeze
-
       def to_hash
         {
           icmp_type: @type,

data/lib/pio/icmp/reply.rb

@@ -24,6 +24,7 @@ module Pio
         def initialize(options)
           validate options
           @type = TYPE
+
           @source_mac = Mac.new(options[:source_mac]).freeze
           @destination_mac = Mac.new(options[:destination_mac]).freeze
           @ip_source_address =
@@ -32,7 +33,7 @@ module Pio
             IPv4Address.new(options[:ip_destination_address]).freeze
           @identifier = options[:identifier]
           @sequence_number = options[:sequence_number]
-          @echo_data = options[:echo_data] || DEFAULT_ECHO_DATA
+          @echo_data = options[:echo_data] || ''
         end
         # rubocop:enable AbcSize
         # rubocop:enable MethodLength

data/lib/pio/icmp/request.rb

@@ -22,45 +22,30 @@ module Pio
         option :sequence_number
         option :echo_data
 
-        def initialize(user_options)
+        # rubocop:disable MethodLength
+        # rubocop:disable AbcSize
+        def initialize(options)
+          validate options
           @type = TYPE
 
-          @options = user_options.dup
-          validate @options
-          set_mac_and_ip_address_options
-          set_identifier_option
-          set_sequence_number_option
-          set_echo_data_option
-        end
-
-        private
-
-        def set_mac_and_ip_address_options
-          @source_mac = Mac.new(@options[:source_mac]).freeze
-          @destination_mac = Mac.new(@options[:destination_mac]).freeze
+          @source_mac = Mac.new(options[:source_mac]).freeze
+          @destination_mac = Mac.new(options[:destination_mac]).freeze
           @ip_source_address =
-            IPv4Address.new(@options[:ip_source_address]).freeze
+            IPv4Address.new(options[:ip_source_address]).freeze
           @ip_destination_address =
-            IPv4Address.new(@options[:ip_destination_address]).freeze
-        end
-
-        def set_identifier_option
+            IPv4Address.new(options[:ip_destination_address]).freeze
           @identifier =
-            @options[:icmp_identifier] ||
-            @options[:identifier] ||
+            options[:icmp_identifier] ||
+            options[:identifier] ||
             DEFAULT_IDENTIFIER
-        end
-
-        def set_sequence_number_option
           @sequence_number =
-            @options[:icmp_sequence_number] ||
-            @options[:sequence_number] ||
+            options[:icmp_sequence_number] ||
+            options[:sequence_number] ||
             DEFAULT_SEQUENCE_NUMBER
+          @echo_data = options[:echo_data] || ''
         end
-
-        def set_echo_data_option
-          @echo_data = (@options[:echo_data] || DEFAULT_ECHO_DATA).freeze
-        end
+        # rubocop:enable AbcSize
+        # rubocop:enable MethodLength
       end
     end
   end

data/lib/pio/ipv4_header.rb

@@ -0,0 +1,64 @@
+require 'pio/payload'
+require 'pio/type/ip_address'
+
+module Pio
+  # IP Version 4 Header Format
+  module IPv4Header
+    include Payload
+
+    IP_PROTOCOL_ICMP = 1
+    IP_PROTOCOL_UDP = 17
+
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    # This method smells of :reek:TooManyStatements
+    def self.included(klass)
+      def klass.ipv4_header(options = {})
+        bit4 :ip_version, value: 0x4
+        bit4 :ip_header_length, initial_value: 0x5
+        uint8 :ip_type_of_service, initial_value: 0
+        uint16be :ip_total_length, initial_value: :calculate_ip_length
+        uint16be :ip_identifier, initial_value: 0
+        bit3 :ip_flag, initial_value: 0
+        bit13 :ip_fragment, initial_value: 0
+        uint8 :ip_ttl, initial_value: 128
+        uint8 :ip_protocol, initial_value: options[:ip_protocol] || 0
+        uint16be :ip_header_checksum, initial_value: :calculate_ip_checksum
+        ip_address :ip_source_address
+        ip_address :ip_destination_address
+        string :ip_option, read_length: :ip_option_length
+      end
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
+
+    private
+
+    def calculate_ip_length
+      ip_header_length * 4 + ip_payload_binary.length
+    end
+
+    # rubocop:disable AbcSize
+    def calculate_ip_checksum
+      sum = [ip_version << 12 | ip_header_length << 8 | ip_type_of_service,
+             ip_total_length,
+             ip_identifier,
+             ip_flag << 13 | ip_fragment,
+             ip_ttl << 8 | ip_protocol,
+             ip_source_address >> 16,
+             ip_source_address & 0xffff,
+             ip_destination_address >> 16,
+             ip_destination_address & 0xffff].reduce(:+)
+      ~((sum & 0xffff) + (sum >> 16)) & 0xffff
+    end
+    # rubocop:enable AbcSize
+
+    def ip_payload_binary
+      binary_after(:ip_option)
+    end
+
+    def ip_option_length
+      20 - ip_header_length * 4
+    end
+  end
+end

data/lib/pio/lldp/frame.rb

@@ -1,16 +1,16 @@
 require 'bindata'
 
+require 'pio/ethernet_header'
 require 'pio/lldp/chassis_id_tlv'
 require 'pio/lldp/optional_tlv'
 require 'pio/lldp/port_id_tlv'
 require 'pio/lldp/ttl_tlv'
-require 'pio/type/ethernet_header'
 
 module Pio
   class Lldp
     # LLDP frame
     class Frame < BinData::Record
-      extend Type::EthernetHeader
+      include EthernetHeader
 
       endian :big
 

data/lib/pio/packet_in.rb

@@ -1,8 +1,8 @@
 require 'bindata'
+require 'pio/ethernet_header'
+require 'pio/ipv4_header'
 require 'pio/open_flow'
 require 'pio/parse_error'
-require 'pio/type/ethernet_header'
-require 'pio/type/ipv4_header'
 
 # Base module.
 module Pio
@@ -49,7 +49,7 @@ module Pio
     class DataParser
       # Ethernet header parser
       class EthernetHeaderParser < BinData::Record
-        extend Pio::Type::EthernetHeader
+        include EthernetHeader
 
         endian :big
 
@@ -59,8 +59,8 @@ module Pio
 
       # IPv4 packet parser
       class IPv4Packet < BinData::Record
-        extend Pio::Type::EthernetHeader
-        extend Type::IPv4Header
+        include EthernetHeader
+        include IPv4Header
 
         endian :big
 

data/lib/pio/payload.rb

@@ -0,0 +1,11 @@
+module Pio
+  # Get payload fields.
+  module Payload
+    def binary_after(field_name)
+      all_fields = field_names(true)
+      all_fields[(all_fields.index(field_name) + 1)..-1].map do |each|
+        __send__(each).to_binary_s
+      end.join
+    end
+  end
+end

data/lib/pio/type/ip_address.rb

@@ -15,6 +15,14 @@ module Pio
         IPv4Address.new(octets.map { |each| format('%d', each) }.join('.'))
       end
 
+      def >>(other)
+        get.to_i >> other
+      end
+
+      def &(other)
+        get.to_i & other
+      end
+
       def ==(other)
         get == other
       end

data/lib/pio/udp.rb

@@ -0,0 +1,19 @@
+require 'bindata'
+require 'pio/ethernet_header'
+require 'pio/ipv4_header'
+require 'pio/udp_header'
+
+module Pio
+  # UDP packet format
+  class Udp < BinData::Record
+    include EthernetHeader
+    include IPv4Header
+    include UdpHeader
+
+    endian :big
+    ethernet_header ether_type: EthernetHeader::ETHER_TYPE_IP
+    ipv4_header ip_protocol: IPv4Header::IP_PROTOCOL_UDP
+    udp_header
+    rest :udp_payload
+  end
+end

data/lib/pio/udp_header.rb

@@ -0,0 +1,56 @@
+require 'pio/payload'
+
+module Pio
+  # UDP Header Format.
+  module UdpHeader
+    include Payload
+
+    # Pseudo UDP header
+    class PseudoUdpHeader < BinData::Record
+      endian :big
+      ip_address :ip_source_address
+      ip_address :ip_destination_address
+      uint8 :padding
+      uint8 :ip_protocol, value: 17
+      uint16 :udp_length
+    end
+
+    def self.included(klass)
+      def klass.udp_header
+        uint16 :udp_source_port
+        uint16 :udp_destination_port
+        uint16 :udp_length, initial_value: :calculate_udp_length
+        uint16 :udp_checksum, initial_value: :calculate_udp_checksum
+      end
+    end
+
+    private
+
+    def calculate_udp_length
+      8 + udp_payload_binary.length
+    end
+
+    def calculate_udp_checksum
+      sum = [*pseudo_udp_header.unpack('n*'),
+             udp_source_port,
+             udp_destination_port,
+             udp_length,
+             *udp_payload_multiple_of_2octets.unpack('n*')].inject(:+)
+      ~((sum & 0xffff) + (sum >> 16)) & 0xffff
+    end
+
+    def udp_payload_binary
+      binary_after :udp_checksum
+    end
+
+    def pseudo_udp_header
+      PseudoUdpHeader.new(ip_source_address: ip_source_address,
+                          ip_destination_address: ip_destination_address,
+                          udp_length: udp_length).to_binary_s
+    end
+
+    def udp_payload_multiple_of_2octets
+      udp_payload_binary + '\x00' * (udp_payload_binary.length.even? ? 0 : 1)
+    end
+  end
+end

data/lib/pio/version.rb

@@ -1,5 +1,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.15.2'.freeze
+  VERSION = '0.16.0'.freeze
 end

data/spec/pio/dhcp_spec.rb

@@ -208,13 +208,13 @@ describe Pio::Dhcp, '.read' do
       end
     end
 
-    describe '#udp_src_port' do
-      subject { super().udp_src_port }
+    describe '#udp_source_port' do
+      subject { super().udp_source_port }
       it { is_expected.to eq 68 }
     end
 
-    describe '#udp_dst_port' do
-      subject { super().udp_dst_port }
+    describe '#udp_destination_port' do
+      subject { super().udp_destination_port }
       it { is_expected.to eq 67 }
     end
 
@@ -530,13 +530,13 @@ describe Pio::Dhcp, '.read' do
       end
     end
 
-    describe '#udp_src_port' do
-      subject { super().udp_src_port }
+    describe '#udp_source_port' do
+      subject { super().udp_source_port }
       it { is_expected.to eq 67 }
     end
 
-    describe '#udp_dst_port' do
-      subject { super().udp_dst_port }
+    describe '#udp_destination_port' do
+      subject { super().udp_destination_port }
       it { is_expected.to eq 68 }
     end
 
@@ -860,13 +860,13 @@ describe Pio::Dhcp, '.read' do
       end
     end
 
-    describe '#udp_src_port' do
-      subject { super().udp_src_port }
+    describe '#udp_source_port' do
+      subject { super().udp_source_port }
       it { is_expected.to eq 68 }
     end
 
-    describe '#udp_dst_port' do
-      subject { super().udp_dst_port }
+    describe '#udp_destination_port' do
+      subject { super().udp_destination_port }
       it { is_expected.to eq 67 }
     end
 
@@ -1182,13 +1182,13 @@ describe Pio::Dhcp, '.read' do
       end
     end
 
-    describe '#udp_src_port' do
-      subject { super().udp_src_port }
+    describe '#udp_source_port' do
+      subject { super().udp_source_port }
       it { is_expected.to eq 67 }
     end
 
-    describe '#udp_dst_port' do
-      subject { super().udp_dst_port }
+    describe '#udp_destination_port' do
+      subject { super().udp_destination_port }
       it { is_expected.to eq 68 }
     end
 

data/spec/pio/icmp/request_spec.rb

@@ -4,6 +4,25 @@ describe Pio::ICMP::Request do
   Then { Pio::ICMP::Request == Pio::Icmp::Request }
 end
 
+describe Pio::Icmp do
+  Given(:icmp_request) do
+    Pio::Icmp::Request.new(
+      destination_mac: '24:db:ac:41:e5:5b',
+      source_mac: '74:e5:0b:2a:18:f8',
+      ip_source_address: '192.168.1.101',
+      ip_destination_address: '8.8.8.8',
+      identifier: 0x123,
+      sequence_number: 0x321,
+      echo_data: 'abcdefghijklmnopqrstuvwabcdefghi'
+    ).to_binary
+  end
+
+  describe '.read' do
+    When(:result) { Pio::Icmp.read icmp_request }
+    Then { result.echo_data == 'abcdefghijklmnopqrstuvwabcdefghi' }
+  end
+end
+
 describe Pio::Icmp::Request, '.new' do
   context 'with echo_data' do
     Given(:icmp_request) do
@@ -22,7 +41,7 @@ describe Pio::Icmp::Request, '.new' do
       When(:result) { icmp_request.to_binary }
 
       Then do
-        result ==
+        result.unpack('C*') ==
           [
             # Destination MAC
             0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
@@ -66,7 +85,7 @@ describe Pio::Icmp::Request, '.new' do
             0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75,
             0x76, 0x77, 0x61, 0x62, 0x63, 0x64, 0x65,
             0x66, 0x67, 0x68, 0x69
-          ].pack('C*')
+          ]
       end
     end
   end
@@ -87,7 +106,7 @@ describe Pio::Icmp::Request, '.new' do
       When(:result) { icmp_request.to_binary }
 
       Then do
-        result ==
+        result.unpack('C*') ==
           [
             # Destination MAC
             0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
@@ -130,7 +149,7 @@ describe Pio::Icmp::Request, '.new' do
             0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
             0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
             0x00, 0x00, 0x00, 0x00
-          ].pack('C*')
+          ]
       end
     end
   end