packetgen 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed1c35530cd3ce2e62507e1a78c92fb5f764a49b
-  data.tar.gz: 77d4baf7bc094aa0b04d7e6035e9420233135008
+  metadata.gz: d08bf3611fcb1af6c5e794d4582fe373b4887c02
+  data.tar.gz: 7149de75ef5a5ebaca9d9b90239ffce8619c38c4
 SHA512:
-  metadata.gz: dbe78e47c236179d9d866ce997778c1b2b65633b751d47d72948bcb0f7f56ccb8bf52fbdd1dd1292844d064493502a11392a7c4c9582552b452522d235bf22b7
-  data.tar.gz: 8c972a697a5bbd5c4654c973b1da378c8e733fb8c1887310b281acd0e36ef5de2e83259da0dfdca75a6da54f3c5af510d7cdc943af338aea839f661663ada014
+  metadata.gz: 82804e0c46bc17d30c6bc151a24b3fc415c476aa1159239330611d2b8ef3ef7d2013dc7078bb40e298d29c0e81f3e758f53e82ff280acc0548b37dc78ff7d8be
+  data.tar.gz: 6f4c84f64e8728af30a61d56b22dce9eb34fa574984eafe427d48cebdac1446344f1f5dd37370604d58b9df4bb1af587135348ad682e15d3ce97d45cfd769ed1

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.2.7
   - 2.3.5
   - 2.4.2
+  - 2.5.0
 
 install:
   - sudo apt-get update -qq

data/README.md

@@ -7,7 +7,11 @@
 PacketGen provides simple ways to generate, send and capture network packets.
 
 ## Installation
-Via RubyGems:
+PacketGen depends on PcapRub, which needs pcap development files to install. On Debian, you have to do:
+
+    $ sudo apt install libpcap-dev
+
+Installation using RubyGems is then easy:
 
     $ gem install packetgen
 

data/lib/packetgen/header.rb

@@ -103,3 +103,7 @@ require_relative 'header/bootp'
 require_relative 'header/dhcp'
 require_relative 'header/http'
 require_relative 'header/tftp'
+require_relative 'header/igmp'
+require_relative 'header/igmpv3'
+require_relative 'header/mld'
+require_relative 'header/mldv2'

data/lib/packetgen/header/icmpv6.rb

@@ -52,7 +52,6 @@ module PacketGen
     end
 
     self.add_class ICMPv6
-
     IPv6.bind_header ICMPv6, next: ICMPv6::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/igmp.rb

@@ -0,0 +1,126 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+
+    # This class supports IGMPv2 (RFC 2236).
+    #
+    # From RFC 2236, a IGMP header has the following format:
+    #   0                   1                   2                   3
+    #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |      Type     | Max Resp Time |           Checksum            |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                         Group Address                         |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # A IGMP header consists of:
+    # * a {#type} field ({Types::Int8Enum} type),
+    # * a {#max_resp_time} field ({Types::Int8} type),
+    # * a {#checksum} field ({Types::Int16} type),
+    # * a {#group_addr} field ({Header::IP::Addr} type),
+    # * and a {#body} (unused for IGMPv2).
+    #
+    # == Create a IGMP header
+    #  # standalone
+    #  igmp = PacketGen::Header::IGMP.new
+    #  # in a packet
+    #  pkt = PacketGen.gen('IP').add('IGMP')
+    #  # access to IGMP header
+    #  pkt.igmp    # => PacketGen::Header::IGMP
+    #
+    # == IGMP attributes
+    #  icmp.type = 'MembershipQuery'   # or 0x11
+    #  icmp.max_resp_time = 20
+    #  icmp.checksum = 0x248a
+    #  icmp.group_addr = '224.0.0.1'
+    # @author Sylvain Daubert
+    class IGMP < Base
+
+      # IGMP internet protocol number
+      IP_PROTOCOL = 2
+      
+      # Known types
+      TYPES = {
+        'MembershipQuery'    => 0x11,
+        'MembershipReportv1' => 0x12,
+        'MembershipReportv2' => 0x16,
+        'LeaveGroup'         => 0x17,
+      }
+
+      # @!attribute type
+      #  8-bit IGMP Type
+      #  @return [Integer]
+      define_field :type, Types::Int8Enum, enum: TYPES
+      # @!attribute max_resp_time
+      #  8-bit IGMP Max Response Time
+      #  @return [Integer]
+      define_field :max_resp_time, Types::Int8
+      # @!attribute checksum
+      #  16-bit IGMP Checksum
+      #  @return [Integer]
+      define_field :checksum, Types::Int16
+      # @!attribute group_addr
+      #  IP Group address
+      #  @return [IP::Addr]
+      define_field :group_addr, IP::Addr, default: '0.0.0.0'
+      # @!attribute body
+      #  @return [String,Base]
+      define_field :body, Types::String
+
+      # @api private
+      # @note This method is used internally by PacketGen and should not be
+      #       directly called
+      def added_to_packet(packet)
+        igmp_idx = packet.headers.size
+        packet.instance_eval "def igmpize() @headers[#{igmp_idx}].igmpize; end"
+      end
+
+      # Get human readbale type
+      # @return [String]
+      def human_type
+        self[:type].to_human
+      end
+
+      # Compute checksum and set +checksum+ field
+      # @return [Integer]
+      def calc_checksum
+        sum = (type << 8) | max_resp_time
+
+        payload = self[:group_addr].to_s + body.to_s
+        payload << "\x00" unless payload.size % 2 == 0
+        payload.unpack('n*').each { |x| sum += x; }
+
+        while sum > 0xffff do
+          sum = (sum & 0xffff) + (sum >> 16)
+        end
+        sum = ~sum & 0xffff
+        self[:checksum].value = (sum == 0) ? 0xffff : sum
+      end
+
+      # Fixup IP header according to RFC 2236:
+      # * set TTL to 1,
+      # * add Router Alert option,
+      # * recalculate checksum and length.
+      # This method may be called as:
+      #    # first method
+      #    pkt.igmp.igmpize
+      #    # second method
+      #    pkt.igmpize
+      # @return [void]
+      def igmpize
+        iph = ip_header(self)
+        iph.ttl = 1
+        iph.options << IP::RA.new
+        packet.calc
+      end
+    end
+
+    self.add_class IGMP
+    IP.bind_header IGMP, op: :and, protocol: IGMP::IP_PROTOCOL, frag: 0, ttl: 1,
+                   tos: ->(v) { v.nil? ? 0 : v != 0xc0 }
+  end
+end

data/lib/packetgen/header/igmpv3.rb

@@ -0,0 +1,150 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+
+    # This class supports IGMPv3 (RFC3376).
+    #
+    # From RFC 3376, a IGMP header has the following format:
+    #   0                   1                   2                   3
+    #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |      Type     | Max Resp Code |           Checksum            |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # A IGMP header consists of:
+    # * a {#type} field ({Types::Int8Enum} type),
+    # * a {#max_resp_time} field ({Types::Int8} type),
+    # * a {#checksum} field ({Types::Int16} type),
+    # * and a {#body}, containing more fields (see below).
+    #
+    # A IGMPv3 header may have additionnal fields. These fields are handled by
+    # additional headers (see {IGMPv3::MQ}).
+    #
+    # == Create a IGMPv3 header
+    #  # standalone
+    #  igmp = PacketGen::Header::IGMPv3.new
+    #  # in a packet
+    #  pkt = PacketGen.gen('IP').add('IGMPv3')
+    #  # access to IGMPv3 header
+    #  pkt.igmp    # => PacketGen::Header::IGMPv3
+    #
+    # == IGMPv3 attributes
+    #  igmp.type = 'MembershipQuery'   # or 0x11
+    #  igmp.max_resp_time = 20
+    #  igmp.checksum = 0x248a
+    #
+    # == IGMPv3 specifics
+    # === Max Resp Code
+    # {#max_resp_code} field of IGMPv3 packets is encoded differently than
+    # previous versions. This encoding permits to set value up to 31743 (instead
+    # of 255 for IGMPv2).
+    #
+    # This encoding is handled by {#max_resp_code} accessors:
+    #   igmp.max_resp_code = 10000
+    #   igmp.max_resp_code   #=> 9728  error due to encoding as a floating point value
+    #
+    # === IGMPv3 Membership Query
+    # With IGMPv3, a Membership Query packet has more fields than with IGMPv2. To
+    # handle those fields, an additional header should be used:
+    #   pkt = PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MQ')
+    #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
+    #   pkt.igmpv3_mq   #=> PacketGen::Header::IGMPv3::MQ
+    #
+    # === IGMPv3 Membership Report
+    # With IGMPv3, a Membership Report packet has more fields than with IGMPv2. To
+    # handle those fields, an additional header should be used:
+    #   pkt =  PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MR')
+    #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
+    #   pkt.igmpv3_mr  #=> PacketGen::Header::IGMPv3::MR
+    # @author Sylvain Daubert
+    class IGMPv3 < IGMP
+
+      # Known types
+      TYPES = {
+        'MembershipQuery'  => 0x11,
+        'MembershipReport' => 0x22,
+      }
+
+      delete_field :group_addr
+      #undef group_addr
+      #undef group_addr=
+
+      # Encode value for IGMPv3 Max Resp Code and QQIC.
+      # Value may be encoded as a float, so some error may occur.
+      # See RFC 3376 §4.1.1 and §4.1.7.
+      # @param [Integer] value
+      # @return [Integer]
+      def self.encode(value)
+        if value < 128
+          value
+        elsif value > 31743
+          255
+        else
+          exp = 0
+          value >>= 3
+          while value > 31 do
+            exp += 1
+            value >>= 1
+          end
+          0x80 | (exp << 4) | (value & 0xf)
+        end
+      end
+
+      # Decode value for IGMPv3 Max Resp Code and QQIC.
+      # See RFC 3376 §4.1.1 and §4.1.7.
+      # @param [Integer] value
+      # @return [Integer]
+      def self.decode(value)
+        if value < 128
+          value
+        else
+          mant = value & 0xf
+          exp = (value >> 4) & 0x7
+          (0x10 | mant) << (exp + 3)
+        end
+      end
+
+      # Getter for +max_resp_time+ for IGMPv3 packets. Use {.decode}.
+      # @return [Integer]
+      def max_resp_time
+        IGMPv3.decode(self[:max_resp_time].value || self[:max_resp_time].default)
+      end
+      alias max_resp_code max_resp_time
+
+      # Setter for +max_resp_time+ for IGMPv3 packets. Use {.encode}.
+      # @param [Integer] value
+      # @return [Integer]
+      def max_resp_time=(value)
+        self[:max_resp_time].value = IGMPv3.encode(value)
+      end
+      alias max_resp_code= max_resp_time=
+
+      # Compute checksum and set +checksum+ field
+      # @return [Integer]
+      def calc_checksum
+        sum = (type << 8) | max_resp_code
+
+        payload = body.to_s
+        payload << "\x00" unless payload.size % 2 == 0
+        payload.unpack('n*').each { |x| sum += x; }
+
+        while sum > 0xffff do
+          sum = (sum & 0xffff) + (sum >> 16)
+        end
+        sum = ~sum & 0xffff
+        self[:checksum].value = (sum == 0) ? 0xffff : sum
+      end
+    end
+
+    self.add_class IGMPv3
+    IP.bind_header IGMPv3, op: :and, protocol: IGMPv3::IP_PROTOCOL, frag: 0, ttl: 1,
+                   tos: 0xc0
+  end
+end
+
+require_relative 'igmpv3/mq'
+require_relative 'igmpv3/mr'

data/lib/packetgen/header/igmpv3/group_record.rb

@@ -0,0 +1,98 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class IGMPv3
+      # Class to handle IGMPv3 Group Records.
+      #
+      # A Group Record is a block of fields containing information
+      # pertaining to the sender's membership in a single multicast group on
+      # the interface from which the Report is sent.
+      #
+      # A Group Record has the following format:
+      #    0                   1                   2                   3
+      #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |  Record Type  |  Aux Data Len |     Number of Sources (N)     |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                       Multicast Address                       |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                       Source Address [1]                      |
+      #   +-                                                             -+
+      #   |                       Source Address [2]                      |
+      #   +-                                                             -+
+      #   .                               .                               .
+      #   .                               .                               .
+      #   .                               .                               .
+      #   +-                                                             -+
+      #   |                       Source Address [N]                      |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                         Auxiliary Data                        .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      # @author Sylvain Daubert
+      class GroupRecord < Types::Fields
+
+        # Known record types
+        RECORD_TYPES = {
+          'MODE_IS_INCLUDE'        => 1,
+          'MODE_IS_EXCLUDE'        => 2,
+          'CHANGE_TO_INCLUDE_MODE' => 3,
+          'CHANGE_TO_EXCLUDE_MODE' => 4,
+          'ALLOW_NEW_SOURCES'      => 5,
+          'BLOCK_OLD_SOURCES'      => 6
+        }
+
+        # @!attribute type
+        #  8-bit record type
+        #  @return [Integer]
+        define_field :type, Types::Int8Enum, enum: RECORD_TYPES
+        # @!attribute aux_data_len
+        #  8-bit length of of the Auxiliary Data field ({#aux_data}), in unit of
+        #  32-bit words
+        #  @return [Integer]
+        define_field :aux_data_len, Types::Int8, default: 0
+        # @!attribute number_of_sources
+        #  16-bit Number of source addresses in {#source_addr}
+        #  @return [Integer]
+        define_field :number_of_sources, Types::Int16, default: 0
+        # @!attribute multicast_addr
+        #  IP multicast address to which this Group Record pertains
+        #  @return [IP::Addr]
+        define_field :multicast_addr, IP::Addr, default: '0.0.0.0'
+        # @!attribute source_addr
+        #  Array of source addresses
+        #  @return [IP::ArrayOfAddr]
+        define_field :source_addr, IP::ArrayOfAddr,
+                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
+        # @!attribute aux_data
+        #  @return [String]
+        define_field :aux_data, Types::String,
+                     builder: ->(h, t) { t.new(length_from: ->() { h[:aux_data_len].to_i * 4 }) }
+
+        def human_type
+          self[:type].to_human
+        end
+
+        def to_human
+          "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
+        end
+      end
+      
+      # Class to handle series of {GroupRecord}.
+      # @author Sylvain Daubert
+      class GroupRecords < Types::Array
+        set_of GroupRecord
+        
+        # Separator used in {#to_human}.
+        HUMAN_SEPARATOR = ';'
+      end
+    end
+  end
+end

data/lib/packetgen/header/igmpv3/mq.rb

@@ -0,0 +1,96 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class IGMPv3
+      # IGMPv3 Membership Query.
+      #
+      # This is a subpayload for IGMPv3 packets only. This kind of payload is
+      # sent by IP multicast routers to query the multicast reception state of
+      # neighboring interfaces. Queries has following format:
+      #    0                   1                   2                   3
+      #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                         Group Address                         |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   | Resv  |S| QRV |     QQIC      |     Number of Sources (N)     |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                       Source Address [1]                      |
+      #   +-                                                             -+
+      #   |                       Source Address [2]                      |
+      #   +-                              .                              -+
+      #   .                               .                               .
+      #   .                               .                               .
+      #   +-                                                             -+
+      #   |                       Source Address [N]                      |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #
+      # Fields are:
+      # * 32-bit {#group_addr} field ({Header::IP::Addr} type),
+      # * 4-bit {#resv}, a reserved field,
+      # * 1-bit {#flag_s} (Suppress Router-Side Processing),
+      # * 3-bit {#qrv} (Querier's Robustness Variable),
+      # * 8-bit {#qqic} (Querier's Query Interval Code),
+      # * 16-bit {#number_of_sources},
+      # * {#source_addr} field, a {IP::ArrayOfAddr} to handle sources addresses.
+      # @author Sylvain Daubert
+      class MQ < Base
+        # @!attribute group_addr
+        #  IP Group address
+        #  @return [IP::Addr]
+        define_field :group_addr, IP::Addr, default: '0.0.0.0'
+        # @!attribute u8
+        #  First 8-bit field, composed of {#resv}, {#flag_s} and {#qrv}
+        #  @return [Integer]
+        define_field :u8, Types::Int8
+        # @!attribute qqic
+        #  8-bit QQIC
+        #  @return [Integer,Float]
+        define_field :qqic, Types::Int8
+        # @!attribute number_of_sources
+        #  16-bit Number of Sources in {#source_addr}
+        #  @return [Integer]
+        define_field :number_of_sources, Types::Int16
+
+        # @!attribute source_addr
+        #  Array of IP source addresses
+        #  @return [IP::ArrayOfAddr]
+        define_field :source_addr, IP::ArrayOfAddr,
+                     builder: ->(h,t) { t.new(counter: h[:number_of_sources]) }
+
+        # @!attribute resv
+        #  4-bit reserved field in
+        #  @return [Integer]
+        # @!attribute flag_s
+        #  1-bit S flag (Suppress Router-Side Processing)
+        #  @return [Boolean]
+        # @!attribute qrv
+        #  3-bit Querier's Robustness Variable
+        #  @return [Integer]
+        define_bit_fields_on :u8, :resv, 4, :flag_s, :qrv, 3
+
+        # Get QQIC value
+        # @note May return a different value from value previously set, as a
+        #   float encoding is used to encode big values. See {IGMPv3.decode}.
+        # @return [Integer]
+        def qqic
+          IGMPv3.decode self[:qqic].to_i
+        end
+
+        # Set QQIC value
+        # @note See {IGMPv3.encode}.
+        # @param [Integer] value
+        # @return [Integer]
+        def qqic=(value)
+          self[:qqic].value = IGMPv3.encode(value)
+        end
+      end
+    end
+
+    self.add_class IGMPv3::MQ
+    IGMPv3.bind_header IGMPv3::MQ, type: 0x11
+  end
+end