packetgen 3.3.3 → 4.1.0

data/lib/packetgen/pcapng/epb.rb

@@ -34,29 +34,29 @@ module PacketGen
       # @!attribute interface_id
       #  32-bit interface ID
       #  @return [Integer]
-      define_field_before :block_len2, :interface_id, Types::Int32, default: 0
+      define_attr_before :block_len2, :interface_id, BinStruct::Int32, default: 0
       # @!attribute tsh
       #  high 32-bit timestamp value
       #  @return [Integer]
-      define_field_before :block_len2, :tsh, Types::Int32, default: 0
+      define_attr_before :block_len2, :tsh, BinStruct::Int32, default: 0
       # @!attribute tsl
       #  low 32-bit imestamp value
       #  @return [Integer]
-      define_field_before :block_len2, :tsl, Types::Int32, default: 0
+      define_attr_before :block_len2, :tsl, BinStruct::Int32, default: 0
       # @!attribute cap_len
       #  32-bit capture length
       #  @return [Integer]
-      define_field_before :block_len2, :cap_len, Types::Int32, default: 0
+      define_attr_before :block_len2, :cap_len, BinStruct::Int32, default: 0
       # @!attribute orig_len
       #  32-bit original length
       #  @return [Integer]
-      define_field_before :block_len2, :orig_len, Types::Int32, default: 0
+      define_attr_before :block_len2, :orig_len, BinStruct::Int32, default: 0
       # @!attribute data
-      #  @return [Types::String]
-      define_field_before :block_len2, :data, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :data, BinStruct::String
       # @!attribute options
-      #  @return [Types::String]
-      define_field_before :block_len2, :options, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :options, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -74,8 +74,6 @@ module PacketGen
       # @option options [Integer] :block_len2 block total length
       def initialize(options={})
         super
-        endianness(options[:endian] || :little)
-        recalc_block_len
         self.type = options[:type] || PcapNG::EPB_TYPE.to_i
       end
 
@@ -87,9 +85,9 @@ module PacketGen
         return self if io.eof?
 
         %i[type block_len interface_id tsh tsl cap_len orig_len].each do |attr|
-          self[attr].read io.read(self[attr].sz)
+          self[attr].read(io.read(self[attr].sz))
         end
-        self[:data].read io.read(self.cap_len)
+        self[:data].read(io.read(self.cap_len))
         read_options(io)
         read_blocklen2_and_check(io)
 
@@ -115,7 +113,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :data, :options
+        pad_field(:data, :options)
         recalc_block_len
         super
       end
@@ -133,7 +131,7 @@ module PacketGen
       def read_options(io)
         data_pad_len = remove_padding(io, self.cap_len)
         options_len = self.block_len - self.cap_len - data_pad_len - MIN_SIZE
-        self[:options].read io.read(options_len)
+        self[:options].read(io.read(options_len))
       end
     end
   end

data/lib/packetgen/pcapng/file.rb

@@ -8,9 +8,24 @@
 
 module PacketGen
   module PcapNG
-    # PcapNG::File is a complete Pcap-NG file handler.
+    # PcapNG::File is a complete Pcap-NG file handler. It provides methods to:
+    # * read and write PcapNG files,
+    # * process packets from such files.
+    #
+    # @example Writing a file
+    #   pkt1 = PacketGen.gen('IP', id: 1).add('TCP')
+    #   pkt2 = PacketGen.gen('IP', id: 2).add('UDP')
+    #   file = PacketGen::PcapNG::File.new
+    #   file.read_array([pkt1, pkt2])
+    #   file.write('/tmp/file.pcapng')
+    #
+    # @example Reading a file
+    #   file = PacketGen::PcapNG::File.new
+    #   pkts = file.read_packets('/tmp/file.pcapng')
+    #
     # @author Sylvain Daubert
-    class File # rubocop:disable Metrics/ClassLength
+    # @author LemonTree55
+    class File
       # Known link types
       KNOWN_LINK_TYPES = {
         LINKTYPE_ETHERNET => 'Eth',
@@ -29,19 +44,19 @@ module PacketGen
       end.freeze
 
       # Get file sections
-      # @return [Array]
+      # @return [Array<SHB>]
       attr_accessor :sections
 
       def initialize
         @sections = []
       end
 
-      # Read a string to populate the object. Note that this appends new blocks to
+      # Read a binary string to populate the object. Note that this appends new blocks to
       # the Pcapng::File object.
       # @param [String] str
       # @return [self]
       def read(str)
-        PacketGen.force_binary(str)
+        str = str.b unless str.encoding == Encoding::BINARY
         io = StringIO.new(str)
         parse_section(io)
         self
@@ -59,11 +74,19 @@ module PacketGen
 
       # Read a given file and analyze it.
       # If given a block, it will yield PcapNG::EPB or PcapNG::SPB objects.
-      # This is the only way to get packet timestamps.
+      # This is the only way to get packet timestamps (via {EPB#timestamp}).
       # @param [String] fname pcapng file name
       # @yieldparam [EPB,SPB] block
       # @return [Integer] return number of yielded blocks (only if a block is given)
       # @raise [ArgumentError] cannot read +fname+
+      # @example Parse packets and get their timestamp
+      #   hsh = {}
+      #   file = PacketGen::PcapNG::File.new
+      #   file.readfile('/tmp/file.pcapng') do |xpb|
+      #     ts = xpb.is_a?(PacketGen::PcapNG::EPB) ? xpb.timestamp : nil
+      #     pkt = PacketGen.parse(xpb.data)
+      #     hsh[pkt] = ts
+      #   end
       def readfile(fname, &blk)
         raise ArgumentError, "cannot read file #{fname}" unless ::File.readable?(fname)
 
@@ -140,35 +163,6 @@ module PacketGen
         @sections.clear
       end
 
-      # @deprecated
-      #  Prefer use of {#to_a} or {#to_h}.
-      # Translates a {File} into an array of packets.
-      # @param [Hash] options
-      # @option options [String] :file if given, object is cleared and filename
-      #   is analyzed before generating array. Else, array is generated from +self+
-      # @option options [Boolean] :keep_timestamps if +true+ (default value: +false+),
-      #   generates an array of hashes, each one with timestamp as key and packet
-      #   as value. There is one hash per packet.
-      # @return [Array<Packet>,Array<Hash>]
-      def file_to_array(options={})
-        Deprecation.deprecated(self.class, __method__)
-
-        file = options[:file] || options[:filename]
-        reread file
-
-        ary = []
-        blk = if options[:keep_timestamps] || options[:keep_ts]
-                proc { |pkt| { pkt.timestamp => pkt.data.to_s } }
-              else
-                proc { |pkt| pkt.data.to_s }
-              end
-        each_packet_with_interface do |pkt, _itf|
-          ary << blk.call(pkt)
-        end
-
-        ary
-      end
-
       # Translates a {File} into an array of packets.
       # @return [Array<Packet>]
       # @since 3.1.6
@@ -197,13 +191,15 @@ module PacketGen
       end
 
       # Writes the {File} to a file.
-      # @param [Hash] options
-      # @option options [Boolean] :append (default: +false+) if set to +true+,
+      # @param [String] filename file name to write
+      # @param [Boolean] append if set to +true+,
       #   the packets are appended to the file, rather than overwriting it
-      # @return [Array] array of 2 elements: filename and size written
-      # @todo for 4.0, replace +options+ by +append+ kwarg
-      def to_file(filename, options={})
-        mode = options[:append] && ::File.exist?(filename) ? 'ab' : 'wb'
+      # @return [Array(String, Integer)] array of 2 elements: filename and size written
+      # @since 4.1.0 Options hash with single +:append+ option is replaced by +append+ keyword argument.
+      # @see #append
+      # @see #write
+      def to_file(filename, append: false)
+        mode = append && ::File.exist?(filename) ? 'ab' : 'wb'
         ::File.open(filename, mode) { |f| f.write(self.to_s) }
         [filename, self.to_s.size]
       end
@@ -211,53 +207,20 @@ module PacketGen
 
       # Shorthand method for writing to a file.
       # @param [#to_s] filename
-      # @return [Array] see return value from {#to_file}
+      # @return [Array(String, Integer)]
+      # @see #to_file
       def write(filename='out.pcapng')
         self.to_file(filename.to_s, append: false)
       end
 
       # Shorthand method for appending to a file.
       # @param [#to_s] filename
-      # @return [Array] see return value from {#to_file}
+      # @return [Array(String, Integer)]
+      # @see #to_file
       def append(filename='out.pcapng')
         self.to_file(filename.to_s, append: true)
       end
 
-      # @deprecated Prefer use of {#read_array} or {#read_hash}.
-      # @overload array_to_file(ary)
-      #  Update {File} object with packets.
-      #  @param [Array] ary as generated by {#file_to_array} or Array of Packet objects.
-      #                 Update {File} object without writing file on disk
-      #  @return [self]
-      # @overload array_to_file(options={})
-      #  Update {File} and/or write it to a file
-      #  @param [Hash] options
-      #  @option options [String] :file file written on disk only if given
-      #  @option options [Array] :array can either be an array of packet data,
-      #                                 or a hash-value pair of timestamp => data.
-      #  @option options [Time] :timestamp set an initial timestamp
-      #  @option options [Integer] :ts_inc set the increment between timestamps.
-      #                                    Defaults to 1
-      #  @option options [Boolean] :append if +true+, append packets to the end of
-      #                                    the file
-      #  @return [Array] see return value from {#to_file}
-      def array_to_file(options={})
-        filename, ary, ts, ts_inc, append = array_to_file_options(options)
-
-        section = create_new_shb_section
-
-        ary.each do |pkt|
-          classify_block(section, epb_from_pkt(pkt, section, ts))
-          ts += ts_inc
-        end
-
-        if filename
-          self.to_f(filename, append: append)
-        else
-          self
-        end
-      end
-
       # Update current object from an array of packets
       # @param [Array<Packet>] packets
       # @param [Time, nil] timestamp initial timestamp, used for first packet
@@ -335,13 +298,13 @@ module PacketGen
       # @param [IO] io stream from which parse SHB
       # @return [SHB]
       def parse_shb(shb, io)
-        type = Types::Int32.new(0, shb.endian).read(io.read(4))
+        type = BinStruct::Int32.new(value: 0, endian: shb.endian).read(io.read(4))
         io.seek(-4, IO::SEEK_CUR)
         parse(type, io, shb)
       end
 
       # Parse a block from its type
-      # @param [Types::Int32] type
+      # @param [BinStruct::Int32] type
       # @param [IO] io stream from which parse block
       # @param [SHB] shb header of current section
       # @return [Block]
@@ -352,7 +315,7 @@ module PacketGen
       end
 
       # Guess class to use from type
-      # @param [Types::Int] type
+      # @param [BinStruct::Int] type
       # @return [Block]
       def guess_block_type(type)
         BLOCK_TYPES.key?(type.to_i) ? BLOCK_TYPES[type.to_i] : UnknownBlock
@@ -376,36 +339,6 @@ module PacketGen
         end
       end
 
-      def array_to_file_options(options)
-        case options
-        when Hash
-          array_to_file_options_from_hash(options)
-        when Array
-          [nil, options, Time.now, 1, false]
-        else
-          raise ArgumentError, 'unknown argument. Need either a Hash or Array'
-        end
-      end
-
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      # Extract and check options for #array_to_file
-      def array_to_file_options_from_hash(options)
-        %i[filename arr ts].each do |deprecated_opt|
-          Deprecation.deprecated_option(self.class, :array_to_file, deprecated_opt) if options[deprecated_opt]
-        end
-
-        filename = options[:filename] || options[:file]
-        ary = options[:array] || options[:arr]
-        raise ArgumentError, ':array parameter needs to be an array' unless ary.is_a? Array
-
-        ts = options[:timestamp] || options[:ts] || Time.now
-        ts_inc = options[:ts_inc] || 1
-        append = !options[:append].nil?
-
-        [filename, ary, ts, ts_inc, append]
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
       def create_new_shb_section
         section = SHB.new
         @sections << section

data/lib/packetgen/pcapng/idb.rb

@@ -8,7 +8,8 @@
 
 module PacketGen
   module PcapNG
-    # {IDB} represents a Interface Description Block (IDB) of a pcapng file.
+    # {IDB} represents an Interface Description Block (IDB) of a pcapng file. It is associated to a network interfaces.
+    # It contains packet data as {EPB} and/or {SPB}.
     #
     # == IDB Definition
     #   Int32   :type           Default: 0x00000001
@@ -36,18 +37,18 @@ module PacketGen
       # @!attribute link_type
       #  16-bit link type
       #  @return [Integer]
-      define_field_before :block_len2, :link_type, Types::Int16, default: 1
+      define_attr_before :block_len2, :link_type, BinStruct::Int16, default: 1
       # @!attribute reserved
       #  16-bit reserved field
       #  @return [Integer]
-      define_field_before :block_len2, :reserved, Types::Int16, default: 0
+      define_attr_before :block_len2, :reserved, BinStruct::Int16, default: 0
       # @!attribute snaplen
       #  32-bit snap length
       #  @return [Integer]
-      define_field_before :block_len2, :snaplen, Types::Int32, default: 0
+      define_attr_before :block_len2, :snaplen, BinStruct::Int32, default: 0
       # @!attribute options
-      #  @return [Types::String]
-      define_field_before :block_len2, :options, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :options, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -61,10 +62,8 @@ module PacketGen
       # @option options [Integer] :block_len2 block total length
       def initialize(options={})
         super
-        endianness(options[:endian] || :little)
         @packets = []
         @options_decoded = false
-        recalc_block_len
         self.type = options[:type] || PcapNG::IDB_TYPE.to_i
       end
 
@@ -76,9 +75,9 @@ module PacketGen
         return self if io.eof?
 
         %i[type block_len link_type reserved snaplen].each do |attr|
-          self[attr].read io.read(self[attr].sz)
+          self[attr].read(io.read(self[attr].sz))
         end
-        self[:options].read io.read(self.block_len - MIN_SIZE)
+        self[:options].read(io.read(self.block_len - MIN_SIZE))
         read_blocklen2_and_check(io)
 
         self
@@ -107,7 +106,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :options
+        pad_field(:options)
         recalc_block_len
         super << @packets.map(&:to_s).join
       end
@@ -119,7 +118,7 @@ module PacketGen
         @options_decoded = true
         return @ts_resol = 1E-6 if tsresol.nil?
 
-        @ts_resol = if (tsresol & 0x80).zero?
+        @ts_resol = if tsresol.nobits?(0x80)
                       10**-tsresol
                     else
                       2**-(tsresol & 0x7f)

data/lib/packetgen/pcapng/shb.rb

@@ -8,7 +8,8 @@
 
 module PacketGen
   module PcapNG
-    # {SHB} represents a Section Header Block (SHB) of a pcapng file.
+    # {SHB} represents a Section Header Block (SHB) of a pcapng file. A SHB contains {IDB}, which contain
+    # {EPB} and/or {SPB}.
     #
     # == SHB Definition
     #   Int32   :type           Default: 0x0A0D0D0A
@@ -45,23 +46,23 @@ module PacketGen
       # @!attribute magic
       #  32-bit magic number
       #  @return [Integer]
-      define_field_before :block_len2, :magic, Types::Int32, default: MAGIC_INT32
+      define_attr_before :block_len2, :magic, BinStruct::Int32, default: MAGIC_INT32
       # @!attribute ver_major
       #  16-bit major version number
       #  @return [Integer]
-      define_field_before :block_len2, :ver_major, Types::Int16, default: 1
+      define_attr_before :block_len2, :ver_major, BinStruct::Int16, default: 1
       # @!attribute ver_major
       #  16-bit minor version number
       #  @return [Integer]
-      define_field_before :block_len2, :ver_minor, Types::Int16, default: 0
+      define_attr_before :block_len2, :ver_minor, BinStruct::Int16, default: 0
       # @!attribute section_len
       #  64-bit section length
       #  @return [Integer]
-      define_field_before :block_len2, :section_len, Types::Int64,
-                          default: SECTION_LEN_UNDEFINED
+      define_attr_before :block_len2, :section_len, BinStruct::Int64,
+                         default: SECTION_LEN_UNDEFINED
       # @!attribute options
-      #  @return [Types::String]
-      define_field_before :block_len2, :options, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :options, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -81,8 +82,6 @@ module PacketGen
         super
         @interfaces = []
         @unknown_blocks = []
-        endianness(options[:endian] || :little)
-        recalc_block_len
         self.type = options[:type] || PcapNG::SHB_TYPE.to_i
       end
 
@@ -93,9 +92,9 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read check_shb(io)
+        self[:type].read(check_shb(io))
         %i[block_len magic ver_major ver_minor section_len].each do |attr|
-          self[attr].read io.read(self[attr].sz)
+          self[attr].read(io.read(self[attr].sz))
         end
         handle_magic_and_check(self[:magic].to_s)
 
@@ -120,7 +119,7 @@ module PacketGen
         body = @interfaces.map(&:to_s).join
         self.section_len = body.size unless self.section_len == SECTION_LEN_UNDEFINED
 
-        pad_field :options
+        pad_field(:options)
         recalc_block_len
         super + body
       end
@@ -135,12 +134,12 @@ module PacketGen
       def force_endianness(endian)
         @endian = endian
         %i[type block_len magic block_len2].each do |attr|
-          self[attr] = Types::Int32.new(0, endian).read(self[attr].to_s)
+          self[attr] = BinStruct::Int32.new(value: 0, endian: endian).read(self[attr].to_s)
         end
         %i[ver_major ver_minor].each do |attr|
-          self[attr] = Types::Int16.new(0, endian).read(self[attr].to_s)
+          self[attr] = BinStruct::Int16.new(value: 0, endian: endian).read(self[attr].to_s)
         end
-        self[:section_len] = Types::Int64.new(0, endian).read(self[:section_len].to_s)
+        self[:section_len] = BinStruct::Int64.new(value: 0, endian: endian).read(self[:section_len].to_s)
       end
 
       # Check io contains a SHB

data/lib/packetgen/pcapng/spb.rb

@@ -8,7 +8,7 @@
 
 module PacketGen
   module PcapNG
-    # {SPB} represents a Section Simple Packet Block (SPB) of a pcapng file.
+    # {SPB} represents a Simple Packet Block (SPB) of a pcapng file.
     #
     # == Pcapng::SPB Definition
     #   Int32   :type           Default: 0x00000003
@@ -29,10 +29,10 @@ module PacketGen
       # @!attribute orig_len
       #  32-bit original length
       #  @return [Integer]
-      define_field_before :block_len2, :orig_len, Types::Int32, default: 0
+      define_attr_before :block_len2, :orig_len, BinStruct::Int32, default: 0
       # @!attribute data
-      #  @return [Types::String]
-      define_field_before :block_len2, :data, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :data, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -45,8 +45,6 @@ module PacketGen
       # @option options [Integer] :block_len2 block total length
       def initialize(options={})
         super
-        endianness(options[:endian] || :little)
-        recalc_block_len
         self.type = options[:type] || PcapNG::SPB_TYPE.to_i
       end
 
@@ -64,11 +62,11 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read io.read(4)
-        self[:block_len].read io.read(4)
-        self[:orig_len].read io.read(4)
+        self[:type].read(io.read(4))
+        self[:block_len].read(io.read(4))
+        self[:orig_len].read(io.read(4))
         data_len = compute_data_len
-        self[:data].read io.read(data_len)
+        self[:data].read(io.read(data_len))
         remove_padding(io, data_len)
         read_blocklen2_and_check(io)
 
@@ -79,7 +77,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :data
+        pad_field(:data)
         recalc_block_len
         super
       end

data/lib/packetgen/pcapng/unknown_block.rb

@@ -20,19 +20,8 @@ module PacketGen
       attr_accessor :section
 
       # @!attribute body
-      #  @return [Types::String]
-      define_field_before :block_len2, :body, Types::String
-
-      # @option options [:little, :big] :endian set block endianness
-      # @option options [Integer] :type
-      # @option options [Integer] :block_len block total length
-      # @option options [::String] :body
-      # @option options [Integer] :block_len2 block total length
-      def initialize(options={})
-        super
-        endianness(options[:endian] || :little)
-        recalc_block_len
-      end
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :body, BinStruct::String
 
       # Has this block options?
       # @return [false]
@@ -48,9 +37,9 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read io.read(4)
-        self[:block_len].read io.read(4)
-        self[:body].read io.read(self[:block_len].to_i - MIN_SIZE)
+        self[:type].read(io.read(4))
+        self[:block_len].read(io.read(4))
+        self[:body].read(io.read(self[:block_len].to_i - MIN_SIZE))
         read_blocklen2_and_check(io)
 
         self
@@ -59,7 +48,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :body
+        pad_field(:body)
         recalc_block_len
         super
       end

data/lib/packetgen/pcapng.rb

@@ -11,16 +11,18 @@ require 'stringio'
 module PacketGen
   # Module to handle PCAP-NG file format.
   # See http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc.cgi?url=https://raw.githubusercontent.com/pcapng/pcapng/master/draft-tuexen-opsawg-pcapng.xml&modeAsFormat=html/ascii&type=ascii
+  #
+  # See {PcapNG::File} to handle Pcap-NG files.
   # @author Sylvain Daubert
   module PcapNG
     # Section Header Block type number
-    SHB_TYPE = Types::Int32.new(0x0A0D0D0A, :little).freeze
+    SHB_TYPE = BinStruct::Int32.new(value: 0x0A0D0D0A, endian: :little).freeze
     # Interface Description Block type number
-    IDB_TYPE = Types::Int32.new(1, :little).freeze
+    IDB_TYPE = BinStruct::Int32.new(value: 1, endian: :little).freeze
     # Simple Packet Block type number
-    SPB_TYPE = Types::Int32.new(3, :little).freeze
+    SPB_TYPE = BinStruct::Int32.new(value: 3, endian: :little).freeze
     # Enhanced Packet Block type number
-    EPB_TYPE = Types::Int32.new(6, :little).freeze
+    EPB_TYPE = BinStruct::Int32.new(value: 6, endian: :little).freeze
 
     # IEEE 802.3 Ethernet (10Mb, 100Mb, 1000Mb, and up)
     LINKTYPE_ETHERNET = 1

data/lib/packetgen/pcaprub_wrapper.rb

@@ -10,6 +10,7 @@ require 'pcaprub'
 module PacketGen
   # Wrapper around PCAPRUB
   # @author Sylvain Daubert
+  # @author LemonTree55
   # @api private
   # @since 3.1.4
   module PCAPRUBWrapper
@@ -35,8 +36,9 @@ module PacketGen
       pcap.setpromisc(promisc)
       pcap.settimeout(TIMEOUT)
       # Monitor MUST be set before pcap is activated
-      pcap.setmonitor monitor unless monitor.nil?
+      pcap.setmonitor(monitor) unless monitor.nil?
       pcap.activate
+      pcap
     end
 
     # Capture packets from a network interface
@@ -74,5 +76,19 @@ module PacketGen
     def self.read_pcap(filename:, &block)
       PCAPRUB::Pcap.open_offline(filename).each_packet(&block)
     end
+
+    # Write binary packets to a PCAP file
+    # @param [String] filename
+    # @param [Array<String>] packets
+    # @return [void]
+    # @since 4.0.0
+    # @author LemonTree55
+    def self.write_pcap(filename:, packets:)
+      PCAPRUB::Pcap.dump_open(filename) do |pcap|
+        packets.each do |packet|
+          pcap.dump(packet)
+        end
+      end
+    end
   end
 end

data/lib/packetgen/proto.rb

@@ -10,7 +10,7 @@
 require 'socket'
 
 module PacketGen
-  # Module handling some helper methods for protocols
+  # Module handling some helper methods for well_known protocols
   # @author Sylvain Daubert
   # @since 2.1.2
   module Proto
@@ -30,6 +30,8 @@ module PacketGen
     # Get protocol number from its name
     # @param [String] name
     # @return [Integer,nil] return nil for unknown protocol names
+    # @example
+    #   PacketGen::Proto.getprotobyname('tcp') #=> 6
     def self.getprotobyname(name)
       @cache[name]
     end
@@ -37,6 +39,8 @@ module PacketGen
     # Get protocol name from its number
     # @param [Integer] num
     # @return [String,nil] return nil for unknown protocol numbers
+    # @example
+    #   PacketGen::Proto.getprotobynumber(6) #=> 'tcp'
     def self.getprotobynumber(num)
       @cache.key(num)
     end