packetgen 2.3.0 → 2.4.0

data/lib/packetgen/header/mld.rb

@@ -0,0 +1,100 @@
+# 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 MLDv1 (RFC 2710).
+    #
+    # From RFC 2710, a MLD 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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |    Maximum Response delay     |           Reserved            |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +                       Multicast Address                       +
+    #   |                                                               |
+    #   +                                                               +
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # A MLD header consists of:
+    # * a {#max_resp_delay} field ({Types::Int16} type),
+    # * a {#reserved} field ({Types::Int16} type),
+    # * a {#mcast_addr} field ({Header::IPv6::Addr} type),
+    # * and a {#body} (unused for MLDv1).
+    #
+    # == Create a MLD header
+    #  # standalone
+    #  mld = PacketGen::Header::MLD.new
+    #  # in a packet
+    #  pkt = PacketGen.gen('IPv6').add('ICMPv6').add('MLD')
+    #  # access to MLD header
+    #  pkt.mld    # => PacketGen::Header::MLD
+    #
+    # == MLD attributes
+    #  pkt.icmpv6.type = 130       # ICMPv6 type 130 is MLD Multicast Listener Query
+    #  pkt.mld.max_resp_delay = 20
+    #  pkt.mld.group_addr = '::'
+    # @author Sylvain Daubert
+    class MLD < Base
+      # @!attribute max_resp_delay
+      #  16-bit MLD Max Response Delay
+      #  @return [Integer]
+      define_field :max_resp_delay, Types::Int16
+      alias max_resp_code max_resp_delay
+      alias max_resp_code= max_resp_delay=
+      # @!attribute reserved
+      #  16-bit Reserved field
+      #  @return [Integer]
+      define_field :reserved, Types::Int16
+      # @!attribute mcast_addr
+      #  IPv6 Multicast address
+      #  @return [IPv6::Addr]
+      define_field :mcast_addr, IPv6::Addr, default: '::'
+      # @!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)
+        mld_idx = packet.headers.size
+        packet.instance_eval "def mldize() @headers[#{mld_idx}].mldize; end"
+      end
+
+      # Fixup IP header according to RFC 2710:
+      # * set Hop limit to 1,
+      # * add Router Alert option,
+      # * recalculate checksum and length.
+      # This method may be called as:
+      #    # first method
+      #    pkt.mld.mldize
+      #    # second method
+      #    pkt.mldize
+      # @return [void]
+      def mldize
+        ipv6 = ip_header(self)
+        ipv6.hop = 1
+        ipv6.next = 0
+        packet.insert(ipv6, 'IPv6::HopByHop', next: ICMPv6::IP_PROTOCOL)
+        packet.ipv6_hopbyhop.options << { type: 'router_alert', value: [0].pack('n') }
+        packet.calc
+      end
+    end
+  end
+end
+
+# Add MLDv2::MLQ before MLD to priorize its decoding
+require_relative 'mldv2'
+
+PacketGen::Header.add_class PacketGen::Header::MLD
+PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 130
+PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 131
+PacketGen::Header::ICMPv6.bind_header PacketGen::Header::MLD, type: 132

data/lib/packetgen/header/mldv2.rb

@@ -0,0 +1,50 @@
+# 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 module contains all MLDv2 specific classes.
+    # @author Sylvain Daubert
+    module MLDv2
+      # Encode value for MLDv2 Max Resp Code.
+      # Value may be encoded as a float, so some error may occur.
+      # See RFC 3810 §5.1.3
+      # @param [Integer] value3
+      # @return [Integer]
+      def self.encode(value)
+        if value < 32768
+          value
+        elsif value > 8_387_583
+          0xffff
+        else
+          exp = 0
+          value >>= 3
+          while value > 8191 do
+            exp += 1
+            value >>= 1
+          end
+          0x8000 | ((exp & 7) << 12) | (value & 0xfff)
+        end
+      end
+
+      # Decode value for MLDv2 Max Resp Code.
+      # See RFC 3810 §5.1.3
+      # @param [Integer] value
+      # @return [Integer]
+      def self.decode(value)
+        if value < 32768
+          value
+        else
+          mant = value & 0xfff
+          exp = (value >> 12) & 0x7
+          (0x1000 | mant) << (exp + 3)
+        end
+      end
+    end
+  end
+end
+
+require_relative 'mldv2/mlq'
+require_relative 'mldv2/mlr'

data/lib/packetgen/header/mldv2/mcast_address_record.rb

@@ -0,0 +1,103 @@
+# 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
+    module MLDv2
+      # Class to handle MLDv2 Mcast Address Records (MAR).
+      #
+      # A Mcast Address 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 [N]                      *
+      #   |                                                               |
+      #   *                                                               *
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                         Auxiliary Data                        .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      # @author Sylvain Daubert
+      class McastAddressRecord < Types::Fields
+
+        # Known record types
+        RECORD_TYPES = IGMPv3::GroupRecord::RECORD_TYPES
+
+        # @!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 Multicast Address Record pertains
+        #  @return [IPv6::Addr]
+        define_field :multicast_addr, IPv6::Addr, default: '::'
+        # @!attribute source_addr
+        #  Array of source addresses
+        #  @return [IPv6::ArrayOfAddr]
+        define_field :source_addr, IPv6::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 {MAR}.
+      # @author Sylvain Daubert
+      class McastAddressRecords < Types::Array
+        set_of McastAddressRecord
+        
+        # Separator used in {#to_human}.
+        HUMAN_SEPARATOR = ';'
+      end
+    end
+  end
+end

data/lib/packetgen/header/mldv2/mlq.rb

@@ -0,0 +1,144 @@
+# 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
+    module MLDv2
+      # This class supports MLDv2 Multicast Listener Query messages.
+      #
+      # From RFC 3810, a MLDv2 Multicast Listener Query message has the
+      # following format:
+      #                      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 = 130   |      Code     |           Checksum            |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |    Maximum Response Code      |           Reserved            |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  *                       Multicast Address                       *
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  | Resv  |S| QRV |     QQIC      |     Number of Sources (N)     |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  *                       Source Address [1]                      *
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  +-                                                             -+
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  *                       Source Address [2]                      *
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  +-                              .                              -+
+      #  .                               .                               .
+      #  .                               .                               .
+      #  +-                                                             -+
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  *                       Source Address [N]                      *
+      #  |                                                               |
+      #  *                                                               *
+      #  |                                                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      # +type+, +code+ and +checksum+ are fields from {ICMPv6} header.
+      #
+      # MLQ fields are:
+      # * {#max_resp_code #max_resp_code} ({Types::Int16}),
+      # * {#reserved #reserved} ({Types::Int16}),
+      # * {#mcast_addr #mcast_addr} ({IPv6::Addr}),
+      # * {#flags} ({Types::Int8}), with sub-fields:
+      #   * a 4-bit {#flag_resv} field,
+      #   * a 1-bit {#flag_s} boolean,
+      #   * a 3-bit {#flag_qrv} field,
+      # * {#qqic} ({Types::Int8}),
+      # * {#number_of_sources} ({Types::Int16}),
+      # * and {#source_addr}, a {IPv6::ArrayOfAddr}.
+      #
+      # == Max Resp Delay
+      # Max Resp Delay is the real delay value. Max Resp Code is the encoded
+      # delay. So {#max_resp_delay} and {#max_resp_code} attributes reflect this
+      # difference.
+      # @author Sylvain Daubert
+      class MLQ < MLD
+        # @!attribute flags
+        #  8-bit flags
+        #  @return [Integer]
+        define_field_before :body, :flags, Types::Int8
+        # @!attribute qqic
+        #  8-bit QQIC
+        #  @return [Integer]
+        define_field_before :body, :qqic, Types::Int8
+        # @!attribute number_of_sources
+        #  16-bit number of sources
+        #  @return [Integer]
+        define_field_before :body, :number_of_sources, Types::Int16
+        # @!attribute source_addr
+        #  Array of IPv6 source addresses
+        #  @return [IPv6::ArrayOfAddr]
+        define_field_before :body, :source_addr, IPv6::ArrayOfAddr,
+                            builder: ->(h,t) { t.new(counter: h[:number_of_sources]) }
+
+        # @!attribute flag_resv
+        #   4-bit reserved field in {#flags}
+        #   @return [Integer]
+        # @!attribute flag_s
+        #   S Flag (Suppress Router-Side Processing)
+        #   @return [Boolean]
+        # @!attribute flag_qrv
+        #   3-bit QRV (Querier's Robustness Variable)
+        #   @return [Integer]
+        define_bit_fields_on :flags, :flag_resv, 4, :flag_s, :flag_qrv, 3
+
+        # Getter for +max_resp_code+ for MLDv2 packets. Use {MLDv2.decode}.
+        # @return [Integer]
+        # @note May return a different value from value previously set, as a
+        #   float encoding is used to encode big values. See {MLDv2.decode}.
+        def max_resp_delay
+          MLDv2.decode(self[:max_resp_delay].to_i)
+        end
+
+        # Setter for +max_resp_code+ for MLDv2 packets. Use {MLDv2.encode}.
+        # @param [Integer] value
+        # @return [Integer]
+        # @note See {MLDv2.encode}.
+        def max_resp_delay=(value)
+          self[:max_resp_delay].value = MLDv2.encode(value)
+        end
+
+        # 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 MLDv2::MLQ
+    ICMPv6.bind_header MLDv2::MLQ, op: :and, type: 130, body: ->(b) { b.nil? ? '' : b.length > 23 }
+
+  end
+end

data/lib/packetgen/header/mldv2/mlr.rb

@@ -0,0 +1,65 @@
+# 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.
+require_relative 'mcast_address_record'
+
+module PacketGen
+  module Header
+    module MLDv2
+      # This class supports MLDv2 Multicast Listener Report messages.
+      #
+      # From RFC 3810, a MLDv2 Multicast Listener Report message 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 = 143   |    Reserved   |           Checksum            |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |           Reserved            |Nr of Mcast Address Records (M)|
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                  Multicast Address Record [1]                 .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                               .                               |
+      #   .                               .                               .
+      #   |                               .                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #   |                                                               |
+      #   .                                                               .
+      #   .                  Multicast Address Record [M]                 .
+      #   .                                                               .
+      #   |                                                               |
+      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      # +type+, +code+ and +checksum+ are fields from {ICMPv6} header.
+      #
+      # MLR fields are:
+      # * {#reserved} ({Types::Int16}),
+      # * {#number_of_mar} (number of mcast address records, {Types::Int16}),
+      # * {#records} ({McastAddrRecords}).
+      # @author Sylvain Daubert
+      class MLR < Base
+        # @!attribute reserved
+        #  16-bit reserved field
+        # @return [Integer]
+        define_field :reserved, Types::Int16, default: 0
+        # @!attribute number_of_mar
+        #  16-bit Number of group records in {#group_records}
+        #  @return [Integer]
+        define_field :number_of_mar, Types::Int16, default: 0
+        
+        # @!attribute records
+        #  Array of Mcast Address Records
+        #  @return [McastAddressRecords]
+        define_field :records, McastAddressRecords,
+                     builder: ->(h, t) { t.new(counter: h[:number_of_mar]) }
+      end
+    end
+    
+    self.add_class MLDv2::MLR
+    ICMPv6.bind_header MLDv2::MLR, type: 143
+  end
+end