pio 0.2.7 → 0.3.0

data/lib/pio/icmp/frame.rb

@@ -0,0 +1,131 @@
+# -*- coding: utf-8 -*-
+require 'pio/type/ethernet_header'
+require 'pio/type/ipv4_header'
+
+module Pio
+  class Icmp
+    # Icmp frame parser.
+    class Frame < BinData::Record
+      PADDED_PACKET_LENGTH = 50
+      MINIMUM_PACKET_LENGTH = 36
+      MINIMUM_FRAME_LENGTH = 64
+
+      extend Type::EthernetHeader
+      extend Type::IPv4Header
+
+      endian :big
+      ethernet_header :ether_type => 0x0800
+      ipv4_header :ip_protocol => 1,
+                  :ip_header_checksum => lambda { ip_sum },
+                  :ip_total_length => lambda { ip_packet_length }
+      uint8 :icmp_type
+      uint8 :icmp_code, :initial_value => 0
+      uint16 :icmp_checksum, :value => lambda { icmp_sum }
+      uint16 :icmp_identifier, :initial_value => 0x0100
+      uint16 :icmp_sequence_number, :initial_value => 0x0001
+      string :echo_data,
+             :initial_value => 'DEADBEEF',
+             :read_length => lambda { echo_data_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 icmp_csum
+        icmp_2bytewise_slices.reduce(0) do |acc, each|
+          acc + each
+        end
+      end
+
+      def ip_sum
+        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
+      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
+      end
+
+      def ipflag_ipfragment
+        ip_flag << 13 | ip_fragment
+      end
+
+      def ipttl_ipproto
+        ip_ttl << 8 | ip_protocol
+      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
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/icmp/message.rb

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+require 'pio/icmp/frame'
+require 'pio/message_util'
+require 'forwardable'
+
+module Pio
+  class Icmp
+    # Base class of Request, Reply, TTL Exceeded and destination unreachable.
+    class Message
+      extend Forwardable
+      include MessageUtil
+
+      def self.create_from(frame)
+        message = allocate
+        message.instance_variable_set :@frame, frame
+        message
+      end
+
+      def initialize(options)
+        @options = options
+        @frame = Icmp::Frame.new(option_hash)
+      end
+
+      def_delegators :@frame, :destination_mac
+      def_delegators :@frame, :source_mac
+      def_delegators :@frame, :ether_type
+      def_delegators :@frame, :ip_version
+      def_delegators :@frame, :ip_header_length
+      def_delegators :@frame, :ip_type_of_service
+      def_delegators :@frame, :ip_total_length
+      def_delegators :@frame, :ip_identifier
+      def_delegators :@frame, :ip_flag
+      def_delegators :@frame, :ip_fragment
+      def_delegators :@frame, :ip_ttl
+      def_delegators :@frame, :ip_protocol
+      def_delegators :@frame, :ip_header_checksum
+      def_delegators :@frame, :ip_source_address
+      def_delegators :@frame, :ip_destination_address
+      def_delegators :@frame, :icmp_type
+      def_delegators :@frame, :icmp_code
+      def_delegators :@frame, :icmp_checksum
+      def_delegators :@frame, :icmp_identifier
+      def_delegators :@frame, :icmp_sequence_number
+      def_delegators :@frame, :echo_data
+      def_delegators :@frame, :to_binary
+
+      private
+
+      # rubocop:disable MethodLength
+      def default_options
+        {
+          :ip_type_of_service => @options[:ip_type_of_service],
+          :ip_identifier => @options[:ip_identifier],
+          :ip_flag => @options[:ip_flag],
+          :ip_fragment => @options[:ip_fragment],
+          :ip_ttl => @options[:ip_ttl],
+          :icmp_type => self.class::TYPE,
+          :icmp_code => @options[:icmp_code],
+          :icmp_identifier => @options[:icmp_identifier],
+          :icmp_sequence_number => @options[:icmp_sequence_number],
+          :echo_data => @options[:echo_data]
+        }
+      end
+      # rubocop:enable MethodLength
+
+      def user_options
+        @options.merge(
+          :source_mac => @options[:source_mac],
+          :destination_mac => @options[:destination_mac],
+          :ip_source_address => @options[:ip_source_address],
+          :ip_destination_address => @options[:ip_destination_address]
+        )
+      end
+
+      def mandatory_options
+        [
+         :source_mac,
+         :destination_mac,
+         :ip_source_address,
+         :ip_destination_address
+        ]
+      end
+
+      def option_to_klass
+        {
+          :source_mac => Mac,
+          :destination_mac => Mac,
+          :ip_source_address => IPv4Address,
+          :ip_destination_address => IPv4Address
+        }
+      end
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/icmp/reply.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+require 'pio/icmp/message'
+
+module Pio
+  class Icmp
+    # ICMP Reply packet generator
+    class Reply < Message
+      TYPE = 0
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/icmp/request.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+require 'pio/icmp/message'
+
+module Pio
+  class Icmp
+    # ICMP Request packet generator
+    class Request < Message
+      TYPE = 8
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/icmp.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
+
+require 'pio/icmp/frame'
+require 'pio/icmp/request'
+require 'pio/icmp/reply'
+require 'pio/util'
+
+module Pio
+  # Icmp parser and generator.
+  class Icmp
+    MESSAGE_TYPE = {
+      Request::TYPE => Request,
+      Reply::TYPE => Reply
+    }
+    class << self
+      include Util
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/ipv4_address.rb

@@ -1,6 +1,6 @@
-require "forwardable"
-require "ipaddr"
-
+# -*- coding: utf-8 -*-
+require 'forwardable'
+require 'ipaddr'
 
 module Pio
   #
@@ -9,13 +9,11 @@ module Pio
   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.
     #
@@ -29,62 +27,56 @@ module Pio
     # @return [IPv4Address] self
     #   a proxy to IPAddr.
     #
-    def initialize addr
+    def initialize(addr)
       case addr
       when Integer
-        @value = IPAddr.new( addr, Socket::AF_INET )
+        @value = IPAddr.new(addr, Socket::AF_INET)
       when String
-        @value = IPAddr.new( addr )
+        @value = IPAddr.new(addr)
       when IPv4Address
         @value = addr.value
       else
-        raise TypeError, "Invalid IPv4 address: #{ addr.inspect }"
+        fail TypeError, "Invalid IPv4 address: #{ addr.inspect }"
       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
 
-
     #
     # @return [Number] prefix length of IPv4 address.
     #
     def prefixlen
       netmask = to_range.first.to_i ^ to_range.last.to_i
       if netmask > 0
-        32 - ( "%b" % netmask ).length
+        32 - sprintf('%b', netmask).length
       else
         32
       end
     end
 
-
     #
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
     #
     def to_a
-      to_s.split( "." ).collect do | each |
+      to_s.split('.').map do | each |
         each.to_i
       end
     end
 
-
     #
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
@@ -93,85 +85,76 @@ module Pio
       to_a
     end
 
-
     #
     # @return [IPv4Address]
     #   Returns the IPv4 address masked with masklen.
     #
-    def mask! masklen
-      @value = @value.mask( masklen )
+    def mask!(masklen)
+      @value = @value.mask(masklen)
       self
     end
-    alias :prefix! :mask!
-
+    alias_method :prefix!, :mask!
 
     #
     # @return [IPv4Address]
     #   Returns the IPv4 address masked with masklen.
     #
-    def mask masklen
-      self.clone.mask!( masklen )
+    def mask(masklen)
+      clone.mask!(masklen)
     end
-    alias :prefix :mask
-
+    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"
+      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"
+      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"
+      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"
+      mask(4).to_s == '224.0.0.0'
     end
-    alias :multicast? :class_d?
-
+    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"
+      mask(4).to_s == '240.0.0.0'
     end
 
-
     #
     # @return [bool]
     #   Returns true if the address is unicast address.
     #
     def unicast?
-      class_a? or class_b? or class_c?
+      class_a? || class_b? || class_c?
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/chassis_id_tlv.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -9,10 +9,11 @@ module Pio
       endian :big
 
       bit7 :tlv_type, :value => 1
-      bit9 :tlv_info_length, :value => lambda { subtype.num_bytes + chassis_id.length }
+      bit9(:tlv_info_length,
+           :value => lambda { subtype.num_bytes + chassis_id.length })
       uint8 :subtype, :initial_value => 7
-      string :chassis_id, :read_length => lambda { tlv_info_length - subtype.num_bytes }
-
+      string(:chassis_id,
+             :read_length => lambda { tlv_info_length - subtype.num_bytes })
 
       def get
         tmp_chassis_id = chassis_id
@@ -27,29 +28,25 @@ module Pio
         end
       end
 
-
-      def set value
-        self.chassis_id = if value.kind_of?( Fixnum ) and subtype == 7
-                            BinData::Uint64be.new( value ).to_binary_s
+      def set(value)
+        self.chassis_id = if subtype == 7
+                            BinData::Uint64be.new(value).to_binary_s
                           else
                             value
                           end
       end
 
-
-      ##########################################################################
       private
-      ##########################################################################
-
 
       def mac_address
-        chassis_id.unpack( "C6" ).collect { | each | "%02x" % each }.join( "" ).hex
+        chassis_id.unpack('C6').map do |each|
+          sprintf '%02x', each
+        end.join('').hex
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/end_of_lldpdu_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -8,12 +8,11 @@ module Pio
     class EndOfLldpduValue < BinData::Record
       endian :big
 
-      stringz :tlv_info_string, :length => 0, :value => ""
+      stringz :tlv_info_string, :length => 0, :value => ''
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/frame.rb

@@ -1,12 +1,12 @@
-require "rubygems"
-require "bindata"
-
-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"
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
+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
@@ -20,66 +20,55 @@ module Pio
       chassis_id_tlv :chassis_id
       port_id_tlv :port_id
       ttl_tlv :ttl, :initial_value => 120
-      array :optional_tlv, :type => :optional_tlv, :read_until => lambda { element.end_of_lldpdu? }
-
+      array(:optional_tlv,
+            :type => :optional_tlv,
+            :read_until => lambda { element.end_of_lldpdu? })
 
       def dpid
         chassis_id.to_i
       end
 
-
       def port_description
-        get_tlv_field 4, "port_description"
+        get_tlv_field 4, 'port_description'
       end
 
-
       def system_name
-        get_tlv_field 5, "system_name"
+        get_tlv_field 5, 'system_name'
       end
 
-
       def system_description
-        get_tlv_field 6, "system_description"
+        get_tlv_field 6, 'system_description'
       end
 
-
       def system_capabilities
         get_tlv 7
       end
 
-
       def management_address
-        get_tlv_field 8, "management_address"
+        get_tlv_field 8, 'management_address'
       end
 
-
       def organizationally_specific
         get_tlv 127
       end
 
-
-      ##########################################################################
       private
-      ##########################################################################
 
-
-      def get_tlv tlv_type
+      def get_tlv(tlv_type)
         tlv = optional_tlv.find do | each |
-          each[ "tlv_type" ] == tlv_type
+          each['tlv_type'] == tlv_type
         end
-        tlv[ "tlv_value" ] if tlv
+        tlv['tlv_value'] if tlv
       end
 
-
-      def get_tlv_field tlv_type, name
-        tlv = get_tlv( tlv_type )
-        tlv[ name ] if tlv
+      def get_tlv_field(tlv_type, name)
+        tlv = get_tlv(tlv_type)
+        tlv[name] if tlv
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/management_address_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -19,7 +19,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix