packetgen 4.0.0 → 4.1.1

data/lib/packetgen/packet.rb

@@ -2,55 +2,63 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# rubocop:disable Metrics/ClassLength
-
 module PacketGen
   # An object of type {Packet} handles a network packet. This packet may contain
   # multiple protocol headers, starting from MAC layer or from Network (OSI) layer.
   #
-  # Creating a packet is fairly simple:
-  #  Packet.gen 'IP', src: '192.168.1.1', dst: '192.168.1.2'
+  # A Packet is created using {.gen} method. Headers may be added to this packet using {#add}.
+  # It may also be created from parsing a binary string, using {.parse} method.
+  #
+  # @example Very simple packet
+  #   # Create a packet with a single IP header. IP source and destination addresses are set.
+  #   pkt = PacketGen::Packet.gen('IP', src: '192.168.1.1', dst: '192.168.1.2')
   #
-  # == Create a packet
-  # Packets may be hand-made or parsed from a binary string:
-  #  Packet.gen('IP', src: '192.168.1.1', dst: '192.168.1.2').add('UDP', sport: 45000, dport: 23)
-  #  Packet.parse(binary_string)
+  # @example Parsing a binary string
+  #  # a IP/ICMP packet, as binary string
+  #  binary_string = "E\x00\x00\x1C\xAA`\x00\x00@\x01M-\xC0\xA8\x01\x01\xC0\xA8\x01\x02\x00\b;1abcd".b
+  #  pkt = PacketGen::Packet.parse(binary_string)
+  #  pkt.is?('IP')    #=> true
+  #  pkt.is?('ICMP')  #=> true
   #
-  # == Access packet information
-  #  pkt = Packet.gen('IP').add('UDP')
-  #  # read information
-  #  pkt.udp.sport
-  #  pkt.ip.ttl
-  #  # set information
-  #  pkt.udp.dport = 2323
-  #  pkt.ip.ttl = 1
-  #  pkt.ip(ttl: 1, id: 1234)
+  # Information for each level is accessible through the associated header. Header is accessible through a
+  # method defined with its name at packet level (i.e. +#ip+ for a IP header).
   #
-  # == Save a packet to a file
-  #  pkt.write('file.pcapng')
+  # @example Accessing header information
+  #   pkt = PacketGen::Packet.gen('IP').add('UDP')
+  #   # read information
+  #   pkt.udp.sport #=> 0
+  #   pkt.ip.ttl    #=> 64
+  #   # set information
+  #   pkt.udp.dport = 2323
+  #   pkt.ip.ttl = 1
+  #   # Set multiple attributes at once
+  #   pkt.ip(ttl: 1, id: 1234)
   #
-  # == Get packets
-  # Packets may be captured from wire:
-  #  Packet.capture do |packet|
-  #    do_some_stuffs
-  #  end
-  #  packets = Packet.capture(iface: 'eth0', max: 5)  # get 5 packets from eth0
+  # Packets may be written to files using {#write}:
+  #   pkt = PacketGen::Packet.gen('Eth')
+  #   pkt.write('file.pcapng')
   #
-  # Packets may also be read from a file:
-  #  packets = Packet.read(file.pcapng)
+  # Packets may be captured from network interfaces:
+  #   # Capture all packets from default interface. Never end.
+  #   PacketGen::Packet.capture do |packet|
+  #     do_some_stuffs
+  #   end
   #
-  # == Save packets to a file
-  #  Packet.write 'file.pcapng', packets
+  #   # Get 5 packets from eth0 interface
+  #   packets = Packet.capture(iface: 'eth0', max: 5)
   #
+  # Finally, packets may also be read from a file:
+  #   packets = Packet.read(file.pcapng)
   # @author Sylvain Daubert
+  # @author LemonTree55
   class Packet
     # Get packet headers, ordered as they appear in the packet.
-    # @return [Array<Header::Base>]
+    # @return [Array<Headerable>]
     attr_reader :headers
     # Activaye or deactivate header cache (activated by default)
     # @return [Boolean]
@@ -142,7 +150,15 @@ module PacketGen
     # @param [String] protocol
     # @param [Hash] options protocol specific options
     # @return [self]
-    # @raise [BindingError] unknown protocol
+    # @raise [ArgumentError] unknown protocol
+    # @raise [BindingError] unknown binding
+    # @see #<<
+    # @example
+    #  pkt = PacketGen::Packet.gen('Eth')
+    #  # Add a IP header
+    #  pkt.add('IP')
+    #  # Add a TCP header, with some attributes and body set
+    #  pkt.add('TCP', dport: 80, seqnum: 123456, body: "abcd".b)
     def add(protocol, options={})
       klass = check_protocol(protocol)
 
@@ -174,6 +190,7 @@ module PacketGen
     end
 
     # Check if a protocol header is embedded in packet.
+    # @example
     #   pkt = PacketGen.gen('IP').add('UDP')
     #   pkt.is?('IP')   #=> true
     #   pkt.is?('TCP')  #=> false
@@ -210,16 +227,22 @@ module PacketGen
       end
     end
 
-    # Get packet body
-    # @return [Types]
+    # Get packet body. If packet (i.e. last header) has no +:body+ field, return +nil+.
+    # @return [Headerable,BinStruct::String,nil]
     def body
       last_header[:body] if last_header.respond_to?(:body)
     end
 
     # Set packet body
-    # @param [String] str
+    # @param [String] str Binary string
     # @return [void]
+    # @raise [Error] Packet (i.e. last header) has no +:body+ field.
+    # @note To set a {Headerable} object, prefer #{<<}
+    # @see #<<
+    # @since 4.1.0 raise {Error} if no body on packet
     def body=(str)
+      raise Error, 'no body in last headeré' unless last_header.respond_to?(:body)
+
       last_header.body = str
     end
 
@@ -270,6 +293,13 @@ module PacketGen
     # @return [self] +self+ updated with new headers from +other+
     # @raise [BindingError] do not known how to encapsulate
     # @since 1.1.0
+    # @example
+    #   # Create a first IP packet
+    #   ip1 = PacketGen::Packet.gen('IP', id: 1)
+    #   # Create second IP packet, to encapsulate in first
+    #   ip2 = PacketGen.gen('IP', id: 2)
+    #   ip1.encapsulate(ip2)
+    #   ip1.ip(2) == ip2.ip
     def encapsulate(other, parsing: false)
       other.headers.each_with_index do |h, i|
         add_header(h, parsing: i.positive? || parsing)
@@ -282,6 +312,12 @@ module PacketGen
     # @raise [FormatError] any headers not in +self+
     # @raise [BindingError] removed headers result in an unknown binding
     # @since 1.1.0
+    # @example
+    #  # IP/IP encapsulation
+    #  pkt = PacketGen::Packet.gen('IP', id: 1).add('IP', id:2)
+    #  # Remove outer IP header
+    #  pkt.decapsulate(pkt.ip(1))
+    #  pkt.ip.id #=> 2
     def decapsulate(*hdrs)
       hdrs.each do |hdr|
         prev_hdr = previous_header(hdr)
@@ -290,6 +326,7 @@ module PacketGen
         add_header(next_hdr, previous_header: prev_hdr) if prev_hdr && next_hdr
       end
       invalidate_header_cache
+      self
     rescue ArgumentError => e
       raise FormatError, e.message
     end
@@ -334,7 +371,7 @@ module PacketGen
       to_s == other.to_s
     end
 
-    # +true+ is {#==} is +true+ with another packet, or if +other+ is a protocol name String, whose protocol is in Packet.
+    # +true+ if {#==} is +true+ with another packet, or if +other+ is a protocol name String, whose protocol is in Packet.
     # @param [Packet] other
     # @return [Boolean]
     # @since 3.1.2
@@ -349,8 +386,9 @@ module PacketGen
       end
     end
 
-    # Invert all possible attributes.in packet to create a reply.
+    # Invert all possible attributes in packet to create a reply.
     # @return [self]
+    # @note Only modify headers responding to +#reply!+.
     # @since 2.7.0
     def reply!
       headers.each do |header|
@@ -362,12 +400,32 @@ module PacketGen
     # Forge a new packet from current one with all possible fields
     # inverted. The new packet may be a reply to current one.
     # @return [Packet]
+    # @note Only modify headers responding to +#reply!+.
     # @since 2.7.0
     def reply
       pkt = dup
       pkt.reply!
     end
 
+    # Append an already defined header to packet
+    # @param [Headerable] header
+    # @return [self]
+    # @raise [ArgumentError] unknown protocol
+    # @raise [BindingError] unknown binding
+    # @example
+    #  pkt = PacketGen.gen('Eth')
+    #  # Add a new header from its type
+    #  pkt.add('IP')
+    #  # Add a new pre-generated header
+    #  pkt << PacketGen::Header::TCP.new
+    # @see #add
+    # @since 4.1.0
+    # @author LemonTree55
+    def <<(header)
+      add_header(header)
+      self
+    end
+
     private
 
     # Dup +@headers+ instance variable. Internally used by +#dup+ and +#clone+

data/lib/packetgen/pcap.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.

data/lib/packetgen/pcapng/block.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -10,6 +10,7 @@ module PacketGen
   module PcapNG
     # @abstract Base class for all block types
     # @author Sylvain Daubert
+    # @author LemonTree55
     class Block < BinStruct::Struct
       # @return [:little, :big]
       attr_accessor :endian
@@ -78,7 +79,7 @@ module PacketGen
       def to_io(str_or_io)
         return str_or_io if str_or_io.respond_to?(:read)
 
-        StringIO.new(force_binary(str_or_io.to_s))
+        StringIO.new(str_or_io.to_s.b)
       end
 
       def remove_padding(io, data_len)

data/lib/packetgen/pcapng/epb.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.

data/lib/packetgen/pcapng/file.rb

@@ -1,16 +1,31 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 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)
 
@@ -168,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
@@ -182,14 +207,16 @@ 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

data/lib/packetgen/pcapng/idb.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 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

data/lib/packetgen/pcapng/shb.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 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

data/lib/packetgen/pcapng/spb.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 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

data/lib/packetgen/pcapng/unknown_block.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.

data/lib/packetgen/pcapng.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -11,6 +11,8 @@ 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

data/lib/packetgen/pcaprub_wrapper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.

data/lib/packetgen/proto.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -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

data/lib/packetgen/unknown_packet.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -20,7 +20,7 @@ module PacketGen
 
     def initialize
       @headers = [].freeze
-      @binary_str = PacketGen.force_binary('')
+      @binary_str = ::String.new # Return empty string with encoding ASCII-8BIT, so BINARY
     end
 
     # Unknown packet, so unknown protocol.
@@ -40,7 +40,7 @@ module PacketGen
     # @param [String] str
     # @return [void]
     def body=(str)
-      @binary_str = PacketGen.force_binary(str)
+      @binary_str = str.b
     end
 
     # Write packet to a PCapNG file on disk.
@@ -56,7 +56,7 @@ module PacketGen
     # @param [String] binary_str
     # @return [self]
     def parse(binary_str, _first_header: nil)
-      @binary_str = PacketGen.force_binary(binary_str)
+      @binary_str = binary_str.b
       self
     end
 

data/lib/packetgen/utils/arp_spoofer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.

data/lib/packetgen/utils.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -71,9 +71,7 @@ module PacketGen
       cache
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
-
-    # Get MAC address from an IP address, or nil if this IP address is unknown
+        # Get MAC address from an IP address, or nil if this IP address is unknown
     # on local network.
     # @param [String] ipaddr dotted-octet IP address
     # @param [Hash] options
@@ -168,7 +166,8 @@ module PacketGen
     def self.mitm(target1, target2, options={}, &block)
       options = { iface: PacketGen.default_iface }.merge(options)
 
-      spoofer = Utils::ARPSpoofer.new(options)
+      spoofer_options = options.slice(:timeout, :interval, :iface)
+      spoofer = Utils::ARPSpoofer.new(**spoofer_options.compact)
       spoofer.add target1, target2, options
       spoofer.add target2, target1, options
 

data/lib/packetgen/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -11,5 +11,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '4.0.0'
+  VERSION = '4.1.1'
 end

data/lib/packetgen.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -13,6 +13,7 @@ require 'interfacez'
 
 # PacketGen is a network packet generator and analyzor.
 # @author Sylvain Daubert
+# @author LemonTree
 module PacketGen
   # Base exception class for PacketGen exceptions
   class Error < StandardError; end
@@ -33,12 +34,15 @@ module PacketGen
     # @return [Headerable]
     attr_reader :hdr
 
+    # @param [Headerable] prev_hdr
+    # @param [Headerable] hdr
     def initialize(prev_hdr, hdr)
       super()
       @prev_hdr = prev_hdr
       @hdr = hdr
     end
 
+    # @return [String]
     def message
       "#{prev_hdr.class} knowns no layer association with #{hdr.protocol_name}. " \
         "Try #{prev_hdr.class}.bind_layer(#{hdr.class}, " \
@@ -92,8 +96,10 @@ module PacketGen
   # Force binary encoding for +str+
   # @param [String] str
   # @return [String] binary encoded string
+  # @deprecated Use +String#b+ instead.
   def self.force_binary(str)
-    str.dup.force_encoding(Encoding::BINARY)
+    Deprecation.deprecated(self, :force_binary, 'String#b')
+    str.b
   end
 
   # Get default network interface (ie. first non-loopback declared interface)
@@ -120,7 +126,7 @@ module PacketGen
   # Shortcut to get a header class
   # @example builtin class
   #   # same as PacketGen::Header::Dot11:Data.new(id: 0xfedc)
-  #   dot11 = PacketGen.header('Dot11::Data', id: 0xfedc)  #=> PacketGen::Header::Dot11:Data
+  #   dot11 = PacketGen.header('Dot11::Data', id: 0xfedc)
   # @example plugin class
   #   require 'packet-plugin-smb'
   #   # same as PacketGen::Plugin::SMB::CloseRequest.new(fid: 0x1234)