packetgen 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d412e2595d6167eeef26384bc6c0a2d125b1053b
-  data.tar.gz: 41408b62486f59daa0b702b8b5405d6626a753d2
+  metadata.gz: c0f4985dff6a759aee18e0ca94ec364686d58304
+  data.tar.gz: 5aed1f1d1075e6c00ccac6f76191fcbf537f0005
 SHA512:
-  metadata.gz: 20c2421f674f009fccdd73496a609a8cac35f51ceba68c2398189b70f1d5d35f5238265074a718909119a98976fcf16b4c9fbac365f417519070508d9a77fede
-  data.tar.gz: 187b90c6786d10451301f97d2a288a6b7921a1f2ca1a4ae83a2df43a5338d306844282833a2c62cf7dde922279d36cfbcd072f12003af10e71e8866791fe68e1
+  metadata.gz: ccc6f02e411f0f2632bb21b49859bb4efa4a7cf76c71a32e035796589dd4acddee1508ef47ed26afb426b6e1060b694a88d6872a4f019863274b4bf9573c2dcc
+  data.tar.gz: ea8b5f8819097303c3134b168fa4eaaa4de4fe00d23d7eb5631f1d1279a0b9bbbf0159c3e1fb6dfc71846ecbe1fc0929c4da010710dcb790ce1e5bdceb365d27

data/lib/packetgen/header.rb

@@ -90,6 +90,7 @@ require_relative 'header/icmp'
 require_relative 'header/arp'
 require_relative 'header/ipv6'
 require_relative 'header/icmpv6'
+require_relative 'header/gre'
 require_relative 'header/udp'
 require_relative 'header/tcp'
 require_relative 'header/esp'

data/lib/packetgen/header/gre.rb

@@ -0,0 +1,90 @@
+# 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
+
+    # Generic Routing Encapsulation (RFC 2784 and 2890)
+    #                       1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 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
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |C| |K|S| Reserved0       | Ver |         Protocol Type         |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |      Checksum (optional)      |       Reserved1 (Optional)    |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |                         Key (optional)                        |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #  |                 Sequence Number (Optional)                    |
+    #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # @author Sylvain Daubert
+    class GRE < Base
+
+      # IP protocol number for GRE
+      IP_PROTOCOL = 47
+
+      define_field :u16, Types::Int16
+
+      # @!attribute c
+      #   @return [Boolean]
+      # @!attribute k
+      #   @return [Boolean]
+      # @!attribute s
+      #   @return [Boolean]
+      # @!attribute reserved0
+      #   @return [Integer]
+      # @!attribute ver
+      #   @return [Integer]
+      define_bit_fields_on :u16, :c, :r, :k, :s, :reserved0, 9, :ver, 3
+
+      # @!attribute protocol_type
+      #   @return [Integer]
+      define_field :protocol_type, Types::Int16
+      # @!attribute checksum
+      #   @return [Integer]
+      define_field :checksum, Types::Int16, default: 0, optional: ->(gre) { gre.c? }
+      # @!attribute reserved1
+      #   @return [Integer]
+      define_field :reserved1, Types::Int16, default: 0, optional: ->(gre) { gre.c? }
+      # @!attribute key
+      #   @return [Integer]
+      define_field :key, Types::Int32, optional: ->(gre) { gre.k? }
+      # @!attribute sequence_number
+      #   @return [Integer]
+      define_field :sequence_number, Types::Int32, optional: ->(gre) { gre.s? }
+      # @!attribute body
+      #  @return [Types::String,Header::Base]
+      define_field :body, Types::String
+
+      alias seqnum sequence_number
+      alias seqnum= sequence_number=
+
+      def initialize(options={})
+        opts = { r: false, reserved0: 0, version: 0 }.merge(options)
+        super(opts)
+      end
+
+      # Compute checksum and set +checksum+ field
+      # @return [Integer]
+      def calc_checksum
+        str = to_s
+        str << "\x00" if str.length % 2 == 1
+        sum = str.unpack('n*').reduce(:+)
+
+        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 GRE
+    IP.bind_header GRE, protocol: GRE::IP_PROTOCOL
+    IPv6.bind_header GRE, next: GRE::IP_PROTOCOL
+
+    GRE.bind_header IP, protocol_type: IP::ETHERTYPE
+    GRE.bind_header IPv6, protocol_type: IPv6::ETHERTYPE
+  end
+end

data/lib/packetgen/packet.rb

@@ -203,7 +203,7 @@ module PacketGen
     # @return [Array] see return from {PcapNG::File#to_file}
     # @see File
     def to_f(filename)
-      File.new.array_to_file(filename: filename, array: [self])
+      PcapNG::File.new.array_to_file(filename: filename, array: [self])
     end
     alias :write :to_f
 

data/lib/packetgen/types/fields.rb

@@ -58,7 +58,9 @@ module PacketGen
     # * +:default+ gives default field value. It may be a simple value (an Integer
     #   for an Int field, for example) or a lambda,
     # * +:builder+ to give a builder/constructor lambda to create field. The lambda
-    #   takes one argument: {Fields} subclass object owning field.
+    #   takes one argument: {Fields} subclass object owning field,
+    # * +:optional+ to define this field as optional. This option takes a lambda
+    #   parameter used to say if this field is present or not.
     # For example:
     #   # 32-bit integer field defaulting to 1
     #   define_field :type, PacketGen::Types::Int32, default: 1
@@ -128,6 +130,9 @@ module PacketGen
       # @option options [Object] :default default value
       # @option options [Lambda] :builder lambda to construct this field.
       #   Parameter to this lambda is the caller object.
+      # @option options [Lambda] :optional define this field as optional. Given lambda
+      #   is used to known if this field is present or not. Parameter to this lambda is
+      #   the being defined Field object.
       # @return [void]
       def self.define_field(name, type, options={})
         define = []
@@ -147,7 +152,7 @@ module PacketGen
         define.delete(0) if type.instance_methods.include? name
         class_eval define.join("\n")
         @field_defs[name] = [type, options.delete(:default), options.delete(:builder),
-                             options]
+                             options.delete(:optional), options]
         @ordered_fields << name
       end
 
@@ -274,12 +279,14 @@ module PacketGen
       #   attributes, as defined by {.define_field} and by {.define_bit_fields_on}.
       def initialize(options={})
         @fields = {}
+        @optional_fields = {}
+
         self.class.class_eval { @field_defs }.each do |field, ary|
           default = ary[1].is_a?(Proc) ? ary[1].call : ary[1]
           @fields[field] = if ary[2]
                              ary[2].call(self)
-                           elsif !ary[3].empty?
-                             ary[0].new(ary[3])
+                           elsif !ary[4].empty?
+                             ary[0].new(ary[4])
                            else
                              ary[0].new
                            end
@@ -292,6 +299,8 @@ module PacketGen
           else
             @fields[field].from_human(value) if @fields[field].respond_to? :from_human
           end
+
+          @optional_fields[field] = ary[3] if ary[3]
         end
         self.class.class_eval { @bit_fields }.each do |bit_field|
           self.send "#{bit_field}=", options[bit_field] if options[bit_field]
@@ -319,6 +328,24 @@ module PacketGen
         @ordered_fields ||= self.class.class_eval { @ordered_fields }
       end
 
+      # Get all optional field name
+      def optional_fields
+        fields.select { |f| is_optional?(f) }
+      end
+
+      # Say if this field is optional
+      # @return [Boolean]
+      def is_optional?(field)
+        @optional_fields.has_key? field
+      end
+
+      # Say if an optional field is present
+      # @return [Boolean]
+      def is_present?(field)
+        return true unless is_optional?(field)
+        @optional_fields[field].call(self)
+      end
+
       # Populate object from a binary string
       # @param [String] str
       # @return [Fields] self
@@ -327,6 +354,7 @@ module PacketGen
         force_binary str
         start = 0
         fields.each do |field|
+          next unless is_present?(field)
           if self[field].respond_to? :width
             width = self[field].width
             self[field].read str[start, width]
@@ -350,6 +378,7 @@ module PacketGen
         str = Inspect.dashed_line(self.class, 2)
         fields.each do |attr|
           next if attr == :body
+          next unless is_present?(attr)
           str << Inspect.inspect_attribute(attr, self[attr], 2)
         end
         str
@@ -358,7 +387,8 @@ module PacketGen
       # Return object as a binary string
       # @return [String]
       def to_s
-        fields.map { |f| force_binary @fields[f].to_s }.join
+        fields.select { |f| is_present?(f) }.
+          map! { |f| force_binary @fields[f].to_s }.join
       end
 
       # Size of object as binary string

data/lib/packetgen/types/int_string.rb

@@ -14,7 +14,7 @@ module PacketGen
 
       # internal string
       # @return [String]
-      attr_accessor :string
+      attr_reader :string
 
       # @param [::String] str
       # @param [Class] len_type should be a {Int} subclass
@@ -28,7 +28,8 @@ module PacketGen
       # @return [IntString] self
       def read(str)
         unless str[0, @length.width].size == @length.width
-          raise ParseError, "String too short for type #{@length.type}"
+          raise ParseError,
+                "String too short for type #{@length.class.to_s.gsub(/.*::/, '')}"
         end
         @length.read str[0, @length.width]
         @string.read str[@length.width, @length.to_i]
@@ -47,6 +48,13 @@ module PacketGen
         @length.to_i
       end
 
+      # @param [#to_s] s
+      # @return [String]
+      def string=(s)
+        @length.value = s.to_s.size
+        @string = s.to_s
+      end
+
       # Get binary string
       # @return [::String]
       def to_s

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-13 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -197,6 +197,7 @@ files:
 - lib/packetgen/header/dot1x.rb
 - lib/packetgen/header/esp.rb
 - lib/packetgen/header/eth.rb
+- lib/packetgen/header/gre.rb
 - lib/packetgen/header/icmp.rb
 - lib/packetgen/header/icmpv6.rb
 - lib/packetgen/header/ike.rb