packetgen 3.1.3 → 3.1.4

data/lib/packetgen/pcapng/shb.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module PcapNG
     # {SHB} represents a Section Header Block (SHB) of a pcapng file.
@@ -89,39 +89,20 @@ module PacketGen
       # @param [::String,IO] str_or_io
       # @return [self]
       def read(str_or_io)
-        io = if str_or_io.respond_to? :read
-               str_or_io
-             else
-               StringIO.new(force_binary(str_or_io.to_s))
-             end
+        io = to_io(str_or_io)
         return self if io.eof?
 
-        type_str = io.read(4)
-        unless type_str == PcapNG::SHB_TYPE.to_s
-          type = type_str.unpack('H*').join
-          raise InvalidFileError, "Incorrect type (#{type})for Section Header Block"
-        end
-
+        type_str = check_shb(io)
         block_len_str = io.read(4)
-
         magic_str = io.read(4)
-        case @endian
-        when :little
-          case magic_str
-          when MAGIC_LITTLE
-          when MAGIC_BIG
-            force_endianness :big
-          else
-            raise InvalidFileError, 'Incorrect magic for Section Header Block'
-          end
-        when :big
-          case magic_str
-          when MAGIC_BIG
-          when MAGIC_LITTLE
-            force_endianness :little
-          else
-            raise InvalidFileError, 'Incorrect magic for Section Header Block'
-          end
+
+        case magic_str
+        when MAGIC_LITTLE
+          force_endianness :little if @endian == :big
+        when MAGIC_BIG
+          force_endianness :big if @endian == :little
+        else
+          raise InvalidFileError, 'Incorrect magic for Section Header Block'
         end
 
         self[:type].read type_str
@@ -149,9 +130,8 @@ module PacketGen
       # @return [String]
       def to_s
         body = @interfaces.map(&:to_s).join
-        unless self.section_len == SECTION_LEN_UNDEFINED
-          self.section_len = body.size
-        end
+        self.section_len = body.size unless self.section_len == SECTION_LEN_UNDEFINED
+
         pad_field :options
         recalc_block_len
         super + body
@@ -169,6 +149,17 @@ module PacketGen
         self[:section_len] = Types::Int64.new(self[:section_len].to_i, endian)
         self[:block_len2] = Types::Int32.new(self[:block_len2].to_i, endian)
       end
+
+      # Check io contains a SHB
+      # @param [IO] io
+      # @return [String] type string
+      def check_shb(io)
+        type_str = io.read(4)
+        return type_str if type_str == PcapNG::SHB_TYPE.to_s
+
+        type = type_str.unpack('H*').join
+        raise InvalidFileError, "Incorrect type (#{type})for Section Header Block"
+      end
     end
   end
 end

data/lib/packetgen/pcapng/spb.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module PcapNG
     # {SPB} represents a Section Simple Packet Block (SPB) of a pcapng file.
@@ -60,11 +60,7 @@ module PacketGen
       # @param [::String,IO] str_or_io
       # @return [self]
       def read(str_or_io)
-        io = if str_or_io.respond_to? :read
-               str_or_io
-             else
-               StringIO.new(force_binary(str_or_io.to_s))
-             end
+        io = to_io(str_or_io)
         return self if io.eof?
 
         self[:type].read io.read(4)
@@ -72,7 +68,7 @@ module PacketGen
         self[:orig_len].read io.read(4)
         # Take care of IDB snaplen
         # CAUTION: snaplen == 0 -> no capture limit
-        data_len = if interface && (interface.snaplen.to_i > 0)
+        data_len = if interface && interface.snaplen.to_i.positive?
                      [self[:orig_len].to_i, interface.snaplen.to_i].min
                    else
                      self[:orig_len].to_i

data/lib/packetgen/pcapng/unknown_block.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module PcapNG
     # {UnknownBlock} is used to handle unsupported blocks of a pcapng file.

data/lib/packetgen/pcaprub_wrapper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# 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 'pcaprub'
+
+module PacketGen
+  # Wrapper around PCAPRUB
+  # @author Sylvain Daubert
+  # @api private
+  # @since 3.1.4
+  module PCAPRUBWrapper
+    # timeout for PCAPRUB
+    TIMEOUT = 1
+    # Default snaplen to use
+    DEFAULT_SNAPLEN = 0xffff
+    # Default promisc value to use
+    DEFAULT_PROMISC = false
+
+    # Open an interface for capturing
+    # @param [String] iface interface name
+    # @param [Integer] snaplen
+    # @param [Boolean] promisc
+    # @return [PCAPRUB::Pcap]
+    def self.open_iface(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC)
+      PCAPRUB::Pcap.open_live(iface, snaplen, promisc, TIMEOUT)
+    end
+
+    # Capture packets from a network interface
+    # @param [String] iface interface name
+    # @param [Integer] snaplen
+    # @param [Boolean] promisc
+    # @param [String] filter BPF filter
+    # @yieldparam [String] packet_data binary packet data
+    # @return [void]
+    def self.capture(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC, filter: nil)
+      pcap = self.open_iface(iface: iface, snaplen: snaplen, promisc: promisc)
+      pcap.setfilter filter unless filter.nil?
+      pcap.each do |packet_data|
+        yield packet_data
+      end
+    end
+
+    # Inject given data onto wire
+    # @param [String] iface interface name
+    # @param [String] data to inject
+    # @return [void]
+    def self.inject(iface:, data:)
+      pcap = self.open_iface(iface: iface)
+      pcap.inject(data)
+      pcap.close
+    end
+
+    # Read a PCAP file
+    # @param [String] filename
+    # @yieldparam [String] data binary packet data
+    # @return [void]
+    # @author Kent Gruber
+    def self.read_pcap(filename:)
+      PCAPRUB::Pcap.open_offline(filename).each_packet do |packet|
+        yield packet
+      end
+    end
+  end
+end

data/lib/packetgen/proto.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 require 'socket'
 
 module PacketGen

data/lib/packetgen/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>

data/lib/packetgen/types/abstract_tlv.rb

@@ -1,16 +1,16 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Types
     # This class is an abstract class to define type-length-value data.
     #
-    # This class supersede {TLV} class, which is not well defined on some corner
+    # This class supersedes {TLV} class, which is not well defined on some corner
     # cases.
     #
     # ===Usage
@@ -33,7 +33,7 @@ module PacketGen
     #   tlv.value       #=> "abcd"
     #
     # ===Advanced usage
-    # Each field's type may be change at generating TLV class:
+    # Each field's type may be changed at generating TLV class:
     #   MyTLV = PacketGen::Types::AbstractTLV.create(type_class: PacketGen::Types::Int16,
     #                                                length_class: PacketGen::Types::Int16,
     #                                                value_class: PacketGen::Header::IP::Addr)
@@ -61,6 +61,7 @@ module PacketGen
       class <<self
         # @return [Hash]
         attr_accessor :aliases
+        attr_accessor :header_in_length
       end
       self.aliases = {}
 
@@ -68,12 +69,17 @@ module PacketGen
       # @param [Class] type_class Class to use for +type+
       # @param [Class] length_class Class to use for +length+
       # @param [Class] value_class Class to use for +value+
+      # @param [Boolean] header_in_length if +true +, +type+ and +length+ fields are
+      #   included in length
       # @return [Class]
-      def self.create(type_class: Int8Enum, length_class: Int8, value_class: String, aliases: {})
+      # @since 3.1.4 Add +header_in_length+ parameter
+      def self.create(type_class: Int8Enum, length_class: Int8, value_class: String,
+                      aliases: {}, header_in_length: false)
         raise Error, '.create cannot be called on a subclass of PacketGen::Types::AbstractTLV' unless self.equal? AbstractTLV
 
         klass = Class.new(self)
         klass.aliases = aliases
+        klass.header_in_length = header_in_length
 
         if type_class < Enum
           klass.define_field :type, type_class, enum: {}
@@ -117,6 +123,7 @@ module PacketGen
       # @option options [Integer] :length
       # @option options [Object] :value
       def initialize(options={})
+        @header_in_length = self.class.header_in_length
         self.class.aliases.each do |al, orig|
           options[orig] = options[al] if options.key?(al)
         end
@@ -136,7 +143,7 @@ module PacketGen
         idx += self[:type].sz
         self[:length].read str[idx, self[:length].sz]
         idx += self[:length].sz
-        self[:value].read str[idx, self.length]
+        self[:value].read str[idx, real_length]
         self
       end
 
@@ -147,6 +154,7 @@ module PacketGen
       def value=(val)
         self[:value].from_human val
         self.length = self[:value].sz
+        self.length += self[:type].sz + self[:length].sz if @header_in_length
         val
       end
 
@@ -163,6 +171,16 @@ module PacketGen
         my_value = self[:value].is_a?(String) ? self[:value].inspect : self[:value].to_human
         "type:%s,length:%u,value:#{my_value}" % [human_type, length]
       end
+
+      private
+
+      def real_length
+        if @header_in_length
+          self.length - self[:type].sz - self[:length].sz
+        else
+          self.length
+        end
+      end
     end
   end
 end

data/lib/packetgen/types/array.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 require 'forwardable'
 
 module PacketGen
@@ -106,7 +106,7 @@ module PacketGen
       # @return [void]
       def clear!
         @array.clear
-        @counter.read(0) if @counter
+        @counter&.read(0)
       end
 
       # Delete an object from this array. Update associated counter if any
@@ -150,7 +150,7 @@ module PacketGen
       # @return [Array] self
       def <<(obj)
         push obj
-        @counter.read(@counter.to_i + 1) if @counter
+        @counter&.read(@counter.to_i + 1)
         self
       end
 
@@ -160,7 +160,7 @@ module PacketGen
       def read(str)
         clear
         return self if str.nil?
-        return self if @counter && @counter.to_i.zero?
+        return self if @counter&.to_i&.zero?
 
         str = read_with_length_from(str)
         klass = self.class.set_of_klass

data/lib/packetgen/types/cstring.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Types
     # This class handles null-terminated strings (aka C strings).

data/lib/packetgen/types/enum.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Types
     # @abstract Base enum class to handle binary integers with limited
@@ -55,6 +55,7 @@ module PacketGen
                  nil
                when ::String
                  raise ArgumentError, "#{value.inspect} not in enumeration" unless @enum.key? value
+
                  @enum[value]
                else
                  value.to_i

data/lib/packetgen/types/fields.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Types
     # @abstract Set of fields
@@ -183,14 +183,14 @@ module PacketGen
                       "  else\n" \
                       "    self[:#{name}]\n" \
                       "  end\n" \
-                      "end"
+                      'end'
             define << "def #{name}=(val)\n" \
                       "  if self[:#{name}].respond_to?(:to_human) && self[:#{name}].respond_to?(:from_human)\n" \
                       "    self[:#{name}].from_human val\n" \
                       "  else\n" \
                       "    self[:#{name}].read val\n" \
                       "  end\n" \
-                      "end"
+                      'end'
           end
 
           define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
@@ -295,9 +295,7 @@ module PacketGen
           raise ArgumentError, "unknown #{attr} field" if attr_def.nil?
 
           type = attr_def.type
-          unless type < Types::Int
-            raise TypeError, "#{attr} is not a PacketGen::Types::Int"
-          end
+          raise TypeError, "#{attr} is not a PacketGen::Types::Int" unless type < Types::Int
 
           total_size = type.new.width * 8
           idx = total_size - 1

data/lib/packetgen/types/int.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Types
     # Base integer class to handle binary integers
@@ -56,9 +56,7 @@ module PacketGen
       # @return [::String]
       # @raise [ParseError] This is an abstrat method and must be redefined
       def to_s
-        unless defined? @packstr
-          raise ParseError, 'PacketGen::Types::Int#to_s is an abstract method'
-        end
+        raise ParseError, 'PacketGen::Types::Int#to_s is an abstract method' unless defined? @packstr
 
         [to_i].pack(@packstr[@endian])
       end