packetgen 2.3.0 → 2.4.0

data/lib/packetgen/header/ip/options.rb

@@ -0,0 +1,53 @@
+# 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 IP
+      
+      # Class to handle IP options
+      # @author Sylvain Daubert
+      class Options < Types::Array
+        set_of Option
+        
+        HUMAN_SEPARATOR = ';'
+
+        # Read IP header options from a string
+        # @param [String] str binary string
+        # @return [self]
+        def read(str)
+          clear
+          return self if str.nil?
+          PacketGen.force_binary str
+
+          i = 0
+          types = Option.types
+          while i < str.to_s.length
+            type = str[i, 1].unpack('C').first
+            this_option = if types[type].nil?
+                            Option.new
+                          else
+                            types[type].new
+                          end
+            this_option.read str[i, str.size]
+            self << this_option
+            i += this_option.sz
+          end
+          self
+        end
+
+        # Get binary string
+        # @return [String]
+        def to_s
+          str = super
+          if str.length % 4 != 0
+            str += ([0] * (4 - (str.length % 4))).pack('C*')
+          end
+          str
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/ipv6.rb

@@ -43,77 +43,11 @@ module PacketGen
     #  ipv6.dst = '2001:1234:5678:abcd::123'
     #  ipv6.body.read 'this is a body'
     # @author Sylvain Daubert
-    class IPv6 < Base
-
-      # IPv6 address, as a group of 8 2-byte words
-      # @author Sylvain Daubert
-      class Addr < Types::Fields
-
-        # @!attribute a1
-        #  1st 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a1, Types::Int16
-        # @!attribute a2
-        #  2nd 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a2, Types::Int16
-        # @!attribute a3
-        #  3rd 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a3, Types::Int16
-        # @!attribute a4
-        #  4th 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a4, Types::Int16
-        # @!attribute a5
-        #  5th 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a5, Types::Int16
-        # @!attribute a6
-        #  6th 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a6, Types::Int16
-        # @!attribute a7
-        #  7th 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a7, Types::Int16
-        # @!attribute a8
-        #  8th 2-byte word of IPv6 address
-        #  @return [Integer]
-        define_field :a8, Types::Int16
-
-        # Read a colon-delimited address
-        # @param [String] str
-        # @return [self]
-        def from_human(str)
-          return self if str.nil?
-          addr = IPAddr.new(str)
-          raise ArgumentError, 'string is not a IPv6 address' unless addr.ipv6?
-          addri = addr.to_i
-          self.a1 = addri >> 112
-          self.a2 = addri >> 96 & 0xffff
-          self.a3 = addri >> 80 & 0xffff
-          self.a4 = addri >> 64 & 0xffff
-          self.a5 = addri >> 48 & 0xffff
-          self.a6 = addri >> 32 & 0xffff
-          self.a7 = addri >> 16 & 0xffff
-          self.a8 = addri & 0xffff
-          self
-        end
-
-        # Addr6 in human readable form (colon-delimited hex string)
-        # @return [String]
-        def to_human
-          IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
-        end
+    class IPv6 < Base;end
 
-        # Return an array of address 16-bit words
-        # @return [Array<Integer>]
-        def to_a
-          @fields.values
-        end
-      end
+    require_relative 'ipv6/addr'
 
+    class IPv6
       # IPv6 Ether type
       ETHERTYPE = 0x86dd
 
@@ -232,3 +166,24 @@ module PacketGen
     IP.bind_header IPv6, protocol: 41    # 6to4
   end
 end
+
+require_relative 'ipv6/extension'
+
+module PacketGen
+  module Header
+    class IPv6
+      class << self
+        alias old_bind_header bind_header
+
+        # Bind a upper header to IPv6 and its defined extension headers.
+        # @see Base.bind_header
+        def bind_header(header_klass, args={})
+          IPv6.old_bind_header header_klass, args
+          [IPv6::HopByHop].each do |klass|
+            klass.bind_header header_klass, args
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/ipv6/addr.rb

@@ -0,0 +1,96 @@
+# coding: utf-8
+# 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 'ipaddr'
+
+module PacketGen
+  module Header
+    class IPv6
+      # IPv6 address, as a group of 8 2-byte words
+      # @author Sylvain Daubert
+      class Addr < Types::Fields
+
+        # @!attribute a1
+        #  1st 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a1, Types::Int16
+        # @!attribute a2
+        #  2nd 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a2, Types::Int16
+        # @!attribute a3
+        #  3rd 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a3, Types::Int16
+        # @!attribute a4
+        #  4th 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a4, Types::Int16
+        # @!attribute a5
+        #  5th 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a5, Types::Int16
+        # @!attribute a6
+        #  6th 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a6, Types::Int16
+        # @!attribute a7
+        #  7th 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a7, Types::Int16
+        # @!attribute a8
+        #  8th 2-byte word of IPv6 address
+        #  @return [Integer]
+        define_field :a8, Types::Int16
+
+        # Read a colon-delimited address
+        # @param [String] str
+        # @return [self]
+        def from_human(str)
+          return self if str.nil?
+          addr = IPAddr.new(str)
+          raise ArgumentError, 'string is not a IPv6 address' unless addr.ipv6?
+          addri = addr.to_i
+          self.a1 = addri >> 112
+          self.a2 = addri >> 96 & 0xffff
+          self.a3 = addri >> 80 & 0xffff
+          self.a4 = addri >> 64 & 0xffff
+          self.a5 = addri >> 48 & 0xffff
+          self.a6 = addri >> 32 & 0xffff
+          self.a7 = addri >> 16 & 0xffff
+          self.a8 = addri & 0xffff
+          self
+        end
+
+        # Addr6 in human readable form (colon-delimited hex string)
+        # @return [String]
+        def to_human
+          IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
+        end
+
+        # Return an array of address 16-bit words
+        # @return [Array<Integer>]
+        def to_a
+          @fields.values
+        end
+      end
+
+      # Class to handle series of IPv6 addresses
+      # @author Sylvain Daubert
+      class ArrayOfAddr < Types::Array
+        set_of IPv6::Addr
+        
+        # Push a IPv6 address to the array
+        # @param [String,Addr] addr
+        # @return [self]
+        #   array << '2001:1234::125'
+        def push(addr)
+          addr = addr.is_a?(Addr) ? addr : Addr.new.from_human(addr)
+          super(addr)
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/ipv6/extension.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.
+
+module PacketGen
+  module Header
+    class IPv6
+      # Base class to handle IPv6 extensions
+      # @abstract You should not use this class but its subclasses.
+      # A IPv6 extension 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
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |  Next Header  |  Hdr Ext Len  |                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
+      #  |                                                               |
+      #  .                                                               .
+      #  .                            Options                            .
+      #  .                                                               .
+      #  |                                                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #
+      # Such a header consists of:
+      # * a {#next} header field ({Types::Int8}),
+      # * a {#length} field ({Types::Int8}),
+      # * an {#options} field ({Types::String}),
+      # * and a {#body}, containing next header.
+      # @author Sylvain Daubert
+      class Extension < Base
+        # @!attribute next
+        #  8-bit Next header field
+        #  @return [Integer]
+        define_field :next, Types::Int8
+        # @!attribute length
+        #  8-bit extension length, in 8-octets units, not including the
+        #  first 8 octets.
+        #  @return [Integer]
+        define_field :length, Types::Int8
+        # @!attribute options
+        #  Specific options of extension header
+        #  @return [String]
+        define_field :options, Types::String,
+                     builder: ->(h, t) { t.new(length_from: ->() { h.real_length }) }
+        # @!attribute body
+        #  @return [String,Base]
+        define_field :body, Types::String
+
+        # Get real extension header length
+        # @return [Integer]
+        def real_length
+          (length + 1) * 8
+        end
+
+        # Compute length and set +len+ field
+        # @return [Integer]
+        def calc_length
+          self.length = (options.sz + 2) / 8 - 1
+        end
+      end
+    end
+  end
+end
+
+require_relative 'hop_by_hop'

data/lib/packetgen/header/ipv6/hop_by_hop.rb

@@ -0,0 +1,132 @@
+# 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 IPv6
+      # Option for {HopByHop} IPv6 extension header
+      # @author Sylvain Daubert
+      class Option < Types::TLV
+        # Known option types
+        TYPES = {
+          1 => 'padn',
+          5 => 'router_alert'
+        }
+
+        # @return [String]
+        def to_human
+          case type
+          when 1
+            "pad#{self.sz}"
+          else
+            "#{human_type}(#{value.to_s.inspect})"
+          end
+        end
+      end
+      
+      # Special option pad1, for {HopByHop} IPv6 extension header
+      # @author Sylvain Daubert
+      class Pad1 < Types::Fields
+        # @!attribute pad
+        # @return [Integer]
+        define_field :pad, Types::Int8, default: 0
+
+        # @return [String]
+        def to_human
+          'pad1'
+        end
+      end
+      
+      # Array of {Option}, for {HopByHop} IPv6 extension header
+      # @author Sylvain Daubert
+      class Options < Types::Array
+        set_of Option
+
+        # Populate object from a binary string
+        # @param [String] str
+        # @return [self]
+        def read(str)
+          clear
+          return self if str.nil?
+          force_binary str
+          klass = self.class.class_eval { @klass }
+          while str.length > 0
+            obj = klass.new.read(str)
+            if obj.type == 0
+              obj = Pad1.new.read(str)
+            end
+            self.push obj
+            str.slice!(0, obj.sz)
+          end
+          self
+        end
+
+        # Get options as a binary string. Add padding if needed.
+        # @return [String]
+        def to_s
+          str = super
+          case str.size % 8
+          when 0
+            return str
+          when 7
+            # only on byte needed: use pad1 option
+            str << [0].pack('C')
+          else
+            # use padn option
+            len = 8 - (str.size % 8) - 4
+            padn = Option.new(type: 'padn', value: "\x00" * len)
+            str << padn.to_s
+          end
+          str
+        end
+      end
+
+      # Hop-by-hop IPv6 extension
+      #
+      #   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
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #  |  Next Header  |  Hdr Ext Len  |                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
+      #  |                                                               |
+      #  .                                                               .
+      #  .                            Options                            .
+      #  .                                                               .
+      #  |                                                               |
+      #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      #
+      # Hop-by-hop IPv6 extension header consists of:
+      # * a {#next} header field ({Types::Int8}),
+      # * a {#length} field ({Types::Int8}),
+      # * an {#options} field ({Options}),
+      # * and a {#body}, containing next header.
+      # @author Sylvain Daubert
+      class HopByHop < Extension
+        # redefine options field
+        delete_field :options
+        # @!attribute options
+        #  Specific options of extension header
+        #  @return [Options]
+        define_field_before :body, :options, Options
+
+        # Populate object from a binary string
+        # @param [String] str
+        # @return [self]
+        def read(str)
+          return self if str.nil?
+          force_binary str
+          self[:next].read str[0, 1]
+          self[:length].read str[1, 1]
+          self[:options].read str[2, real_length - 2]
+          self[:body].read str[real_length..-1]
+          self
+        end
+      end
+    end
+    
+    self.add_class IPv6::HopByHop
+    IPv6.bind_header IPv6::HopByHop, next: 0
+  end
+end