pio 0.30.0 → 0.30.2

data/lib/pio/arp/request.rb

@@ -1,44 +1,22 @@
+# frozen_string_literal: true
+
 require 'pio/arp/message'
+require 'pio/instance_inspector'
 require 'pio/mac'
-require 'pio/options'
 
 module Pio
   class Arp
     # ARP Request packet generator
     class Request < Message
-      OPERATION = 1
-      public_class_method :new
-
-      # User options for creating an Arp Request.
-      class Options < Pio::Options
-        mandatory_option :source_mac
-        mandatory_option :sender_protocol_address
-        mandatory_option :target_protocol_address
-
-        BROADCAST_MAC = Mac.new(0xffffffffffff).freeze
-        ALL_ZERO_MAC = Mac.new(0).freeze
-
-        def initialize(options)
-          validate options
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @sender_protocol_address =
-            IPv4Address.new(options[:sender_protocol_address]).freeze
-          @target_protocol_address =
-            IPv4Address.new(options[:target_protocol_address]).freeze
-        end
+      include InstanceInspector
 
-        def to_hash
-          {
-            operation: OPERATION,
-            source_mac: @source_mac,
-            destination_mac: BROADCAST_MAC,
-            sender_hardware_address: @source_mac,
-            target_hardware_address: ALL_ZERO_MAC,
-            sender_protocol_address: @sender_protocol_address,
-            target_protocol_address: @target_protocol_address
-          }.freeze
-        end
-      end
+      option :operation, value: 1
+      option :source_mac
+      option :destination_mac, default: 'ff:ff:ff:ff:ff:ff'
+      option :sender_hardware_address, value: :source_mac
+      option :target_hardware_address, default: '00:00:00:00:00:00'
+      option :sender_protocol_address
+      option :target_protocol_address
     end
   end
 end

data/lib/pio/arp.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 require 'pio/arp/format'
-require 'pio/arp/request'
 require 'pio/arp/reply'
-require 'pio/message_type_selector'
+require 'pio/arp/request'
+require 'pio/parse_error'
 
-# Packet parser and generator library.
 module Pio
   # ARP parser and generator.
   class Arp
-    extend MessageTypeSelector
-    message_type Request::OPERATION => Request, Reply::OPERATION => Reply
+    def self.read(raw_data)
+      format = Format.read(raw_data)
+      { Request.operation => Request,
+        Reply.operation => Reply }.fetch(format.operation).create(format)
+    rescue
+      raise Pio::ParseError, $ERROR_INFO.message
+    end
   end
-  ARP = Arp
 end

data/lib/pio/class_inspector.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module Pio
+  # Introduces Class.inspect method
+  module ClassInspector
+    # rubocop:disable LineLength
+    def inspect
+      field_and_type = fields.each_with_object([]) do |each, result|
+        next if each.name == :padding
+        result << [each.name,
+                   each.prototype.instance_variable_get(:@obj_class).name.demodulize.sub(/be$/, '').underscore]
+      end
+      signature = field_and_type.map { |field, type| "#{field}: #{type}" }.join(', ')
+      "#{self}(#{signature})"
+    end
+    # rubocop:enable LineLength
+  end
+end

data/lib/pio/dhcp/ack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/boot_reply'
 
 module Pio

data/lib/pio/dhcp/boot_reply.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/message'
 require 'pio/dhcp/boot_reply_options'
 

data/lib/pio/dhcp/boot_reply_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/options'
 require 'pio/dhcp/common_options'
 require 'pio/dhcp/dhcp_tlv_options'

data/lib/pio/dhcp/boot_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/message'
 require 'pio/dhcp/boot_request_options'
 

data/lib/pio/dhcp/boot_request_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/options'
 require 'pio/dhcp/common_options'
 require 'pio/dhcp/dhcp_tlv_options'

data/lib/pio/dhcp/client_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/type/mac_address'
 
 module Pio

data/lib/pio/dhcp/common_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   class Dhcp
     # DHCP Common Options.

data/lib/pio/dhcp/dhcp_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/optional_tlv'
 require 'pio/type/ip_address'
 require 'pio/type/mac_address'

data/lib/pio/dhcp/dhcp_tlv_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/common_options'
 
 module Pio
@@ -31,11 +33,13 @@ module Pio
       end
 
       def dhcp_server_identifier_hash
-        {
-          tlv_type: Dhcp::SERVER_IDENTIFIER_TLV,
-          tlv_info_length: 4,
-          tlv_value: server_identifier
-        } if server_identifier
+        if server_identifier
+          {
+            tlv_type: Dhcp::SERVER_IDENTIFIER_TLV,
+            tlv_info_length: 4,
+            tlv_value: server_identifier
+          }
+        end
       end
 
       def parameters_list_hash
@@ -47,19 +51,23 @@ module Pio
       end
 
       def renewal_time_value_hash
-        {
-          tlv_type: Dhcp::RENEWAL_TIME_VALUE_TLV,
-          tlv_info_length: 4,
-          tlv_value: renewal_time_value
-        } if renewal_time_value
+        if renewal_time_value
+          {
+            tlv_type: Dhcp::RENEWAL_TIME_VALUE_TLV,
+            tlv_info_length: 4,
+            tlv_value: renewal_time_value
+          }
+        end
       end
 
       def rebinding_time_value_hash
-        {
-          tlv_type: Dhcp::REBINDING_TIME_VALUE_TLV,
-          tlv_info_length: 4,
-          tlv_value: rebinding_time_value
-        } if rebinding_time_value
+        if rebinding_time_value
+          {
+            tlv_type: Dhcp::REBINDING_TIME_VALUE_TLV,
+            tlv_info_length: 4,
+            tlv_value: rebinding_time_value
+          }
+        end
       end
 
       def ip_address_lease_time_hash
@@ -71,11 +79,13 @@ module Pio
       end
 
       def subnet_mask_hash
-        {
-          tlv_type: Dhcp::SUBNET_MASK_TLV,
-          tlv_info_length: 4,
-          tlv_value: subnet_mask
-        } if subnet_mask
+        if subnet_mask
+          {
+            tlv_type: Dhcp::SUBNET_MASK_TLV,
+            tlv_info_length: 4,
+            tlv_value: subnet_mask
+          }
+        end
       end
     end
   end

data/lib/pio/dhcp/discover.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/boot_request'
 
 module Pio

data/lib/pio/dhcp/field_util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   class Dhcp
     # Dhcp Field Read Methods.
@@ -93,7 +95,7 @@ module Pio
 
       def get_tlv_field(tlv_type)
         tlv = get_tlv(tlv_type)
-        tlv.snapshot if tlv
+        tlv&.snapshot
       end
     end
   end

data/lib/pio/dhcp/frame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/dhcp_field'
 require 'pio/dhcp/field_util'
 require 'pio/ipv4_header'
@@ -12,12 +14,12 @@ module Pio
 
       OPTION_FIELD_LENGTH = 60
 
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
       include UdpHeader
 
       endian :big
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header ip_protocol: ProtocolNumber::UDP
       udp_header
       dhcp_field :dhcp
@@ -31,7 +33,7 @@ module Pio
 
       def ff_and_padding
         padding_length = OPTION_FIELD_LENGTH - dhcp.optional_tlvs.num_bytes - 1
-        "\xFF" + (padding_length > 0 ? "\x00" * padding_length : '')
+        [0xFF].pack('C') + (padding_length > 0 ? "\x00" * padding_length : '')
       end
     end
   end

data/lib/pio/dhcp/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/frame'
 require 'forwardable'
 

data/lib/pio/dhcp/offer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/boot_reply'
 
 module Pio

data/lib/pio/dhcp/optional_tlv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/parameter_list'
 require 'pio/dhcp/client_id'
 require 'pio/type/ip_address'
@@ -13,9 +15,9 @@ module Pio
 
       bit8 :tlv_type
       bit8 :tlv_info_length,
-           onlyif: -> { !(end_of_dhcpdu?) }
+           onlyif: -> { !end_of_dhcpdu? }
       choice :tlv_value,
-             onlyif: -> { !(end_of_dhcpdu?) },
+             onlyif: -> { !end_of_dhcpdu? },
              selection: :chooser do
         uint8 Dhcp::MESSAGE_TYPE_TLV
         ip_address Dhcp::SERVER_IDENTIFIER_TLV

data/lib/pio/dhcp/parameter_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/dhcp/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/dhcp/boot_request'
 
 module Pio

data/lib/pio/dhcp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Packet parser and generator library.
 module Pio
   # Dhcp parser and generator.
@@ -22,7 +24,7 @@ module Pio
         ROUTER_TLV,
         DNS_TLV,
         NTP_SERVERS_TLV
-      ]
+      ].freeze
   end
   DHCP = Dhcp
 end
@@ -41,7 +43,7 @@ module Pio
       Offer::TYPE => Offer,
       Request::TYPE => Request,
       Ack::TYPE => Ack
-    }
+    }.freeze
 
     def self.read(raw_data)
       begin

data/lib/pio/ethernet_frame.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bindata'
+require 'pio/ethernet_header'
+require 'pio/class_inspector'
+require 'pio/instance_inspector'
+require 'pio/ruby_dumper'
+
+module Pio
+  # Ethernet frame parser
+  class EthernetFrame < BinData::Record
+    extend ClassInspector
+    include Ethernet
+    include InstanceInspector
+    include RubyDumper
+
+    endian :big
+
+    ethernet_header
+    rest :rest
+  end
+end

data/lib/pio/ethernet_header.rb

@@ -1,10 +1,18 @@
+# frozen_string_literal: true
+
+require 'pio/class_inspector'
+require 'pio/instance_inspector'
+require 'pio/ruby_dumper'
+require 'pio/type/ether_type'
 require 'pio/type/mac_address'
 
 module Pio
   # Adds ethernet_header macro.
-  module EthernetHeader
-    # EtherType constants for ethernet_header.ether_type.
-    module EtherType
+  module Ethernet
+    MINIMUM_FRAME_SIZE = 64
+
+    # EtherType constants
+    module Type
       ARP = 0x0806
       IPV4 = 0x0800
       VLAN = 0x8100
@@ -12,28 +20,44 @@ module Pio
     end
 
     # This method smells of :reek:TooManyStatements
+    # rubocop:disable MethodLength
     def self.included(klass)
-      def klass.ethernet_header(options)
+      def klass.ethernet_header(options = nil)
         mac_address :destination_mac
         mac_address :source_mac
-        uint16 :ether_type, value: options.fetch(:ether_type)
-        bit3 :vlan_pcp_internal, onlyif: :vlan?
+        if options
+          ether_type :ether_type, value: options.fetch(:ether_type)
+        else
+          ether_type :ether_type
+        end
+        bit3 :vlan_pcp, onlyif: :vlan?
         bit1 :vlan_cfi, onlyif: :vlan?
-        bit12 :vlan_vid_internal, onlyif: :vlan?
+        bit12 :vlan_vid, onlyif: :vlan?
         uint16 :ether_type_vlan, value: :ether_type, onlyif: :vlan?
       end
     end
+    # rubocop:enable MethodLength
 
-    def vlan_vid
-      vlan? ? vlan_vid_internal : 0xffff
+    def ethernet_header_length
+      vlan? ? 18 : 14
     end
 
-    def vlan_pcp
-      vlan? ? vlan_pcp_internal : 0
-    end
+    private
 
     def vlan?
-      ether_type == EtherType::VLAN
+      ether_type == Type::VLAN
     end
   end
+
+  # Ethernet header generator/parser
+  class EthernetHeader < BinData::Record
+    extend ClassInspector
+    include Ethernet
+    include InstanceInspector
+    include RubyDumper
+
+    endian :big
+
+    ethernet_header
+  end
 end

data/lib/pio/icmp/format.rb

@@ -1,37 +1,35 @@
-require 'bindata'
+# frozen_string_literal: true
+
 require 'pio/ethernet_header'
 require 'pio/ipv4_header'
+require 'pio/monkey_patch/bindata_record'
 
 module Pio
-  # Icmp parser and generator.
+  # ICMP parser and generator
   class Icmp
-    # Icmp parser.
+    # ICMP format
     class Format < BinData::Record
-      MINIMUM_IP_PACKET_LENGTH = 50
-
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
 
       endian :big
 
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header ip_protocol: ProtocolNumber::ICMP
       uint8 :icmp_type
       uint8 :icmp_code, initial_value: 0
       uint16 :icmp_checksum, value: :calculate_icmp_checksum
       uint16 :icmp_identifier
       uint16 :icmp_sequence_number
-      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
-
-      alias_method :to_binary, :to_binary_s
+      string :echo_data, read_length: :echo_data_length
+      string :padding, length: :padding_length
 
       private
 
+      def icmp_header_length
+        8
+      end
+
       def calculate_icmp_checksum
         sum = [icmp_type * 0x100 + icmp_code,
                icmp_identifier,
@@ -40,14 +38,15 @@ module Pio
         ~((sum & 0xffff) + (sum >> 16)) & 0xffff
       end
 
-      def echo_data_read_length
-        ip_total_length - (ip_header_length * 4) - 8
+      def echo_data_length
+        ip_total_length - ip_header_length_in_bytes - icmp_header_length
       end
 
-      def icmp_padding_length
-        length = MINIMUM_IP_PACKET_LENGTH -
-                 (ip_header_length * 4) - 8 - echo_data.length
-        length > 0 ? "\x00" * length : ''
+      def padding_length
+        tmp = Ethernet::MINIMUM_FRAME_SIZE -
+              ethernet_header_length - ip_header_length_in_bytes -
+              icmp_header_length - echo_data.length
+        tmp > 0 ? tmp : 0
       end
     end
   end

data/lib/pio/icmp/message.rb

@@ -1,14 +1,30 @@
+# frozen_string_literal: true
+
+require 'pio/class_inspector'
 require 'pio/icmp/format'
+require 'pio/instance_inspector'
+require 'pio/message'
+require 'pio/ruby_dumper'
 
 module Pio
   class Icmp
     # Base class of Icmp::Request and Icmp::Reply.
-    class Message
-      private_class_method :new
+    class Message < Pio::Message
+      extend ClassInspector
+      include InstanceInspector
+
+      def self.fields
+        Icmp::Format.fields
+      end
+
+      def self.create(format)
+        allocate.tap do |message|
+          message.instance_variable_set :@format, format
+        end
+      end
 
       def initialize(user_options)
-        options = self.class.const_get(:Options).new(user_options)
-        @format = Icmp::Format.new(options.to_hash)
+        @format = Icmp::Format.new(parse_options(user_options))
       end
 
       def method_missing(method, *args)

data/lib/pio/icmp/reply.rb

@@ -1,43 +1,19 @@
+# frozen_string_literal: true
+
 require 'pio/icmp/message'
-require 'pio/icmp/options'
-require 'pio/mac'
 
 module Pio
   class Icmp
     # ICMP Reply packet generator
     class Reply < Message
-      TYPE = 0
-      public_class_method :new
-
-      # User options for creating an ICMP Reply.
-      class Options < Pio::Icmp::Options
-        mandatory_option :source_mac
-        mandatory_option :destination_mac
-        mandatory_option :source_ip_address
-        mandatory_option :destination_ip_address
-        mandatory_option :identifier
-        mandatory_option :sequence_number
-        option :echo_data
-
-        # rubocop:disable MethodLength
-        # rubocop:disable AbcSize
-        def initialize(options)
-          validate options
-          @type = TYPE
-
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @source_ip_address =
-            IPv4Address.new(options[:source_ip_address]).freeze
-          @destination_ip_address =
-            IPv4Address.new(options[:destination_ip_address]).freeze
-          @identifier = options[:identifier]
-          @sequence_number = options[:sequence_number]
-          @echo_data = options[:echo_data] || ''
-        end
-        # rubocop:enable AbcSize
-        # rubocop:enable MethodLength
-      end
+      option :icmp_type, value: 0
+      option :source_mac
+      option :destination_mac
+      option :source_ip_address
+      option :destination_ip_address
+      option :icmp_identifier
+      option :icmp_sequence_number
+      option :echo_data, default: ''
     end
   end
 end