packetgen 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984125cdf335b4573a862ed481c155740f07588e10263da4a35455a9d2d4f803
-  data.tar.gz: 01df13a9c405ba0887a540b952eb8ddea6c1dd8f58adfc1689b8ec0c628b14f4
+  metadata.gz: ed11e05d37fb82187dbf1dc0a7dffd1e6c1931ebda0dea904da77f2731a523f8
+  data.tar.gz: e36705786a664ac257d1939a9c67d267a15c52f51e76b02069c923095c0d8852
 SHA512:
-  metadata.gz: bec2e6720c1a658f777826dc2b7ad81b3cc1addeee5dd99b147357b005151b69d4df3b9c02fd529644a9dd9634106da3fb2b5d73d892769d85d7ef480347e7d7
-  data.tar.gz: 897ebe8f59b88ad3b72eb8edc5a9a23f46228fda646453e2878a3b6a534d53620d58c5ec1396f5632727577a41cbab565d42f50714d9138e907a63de7e3d804d
+  metadata.gz: 151754f39d113f9dbeb65cda8f62f4e378440aa567c3e528b2d8e93920e70069a55bd26e737c03818a808463a9b3406805dcb8ed92e8b5582fbbfaae7f5d8fd4
+  data.tar.gz: 4f61a79f28f1fe8e5f4cac45b9b8fdc06eeca4ae4a07a567334535b3e8ac7ea5cb85cb6644215656e6c0e7e2d1ba0a58bae1fe66131805af7093742dc5098bdd

data/README.md

@@ -1,6 +1,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/packetgen.svg)](https://badge.fury.io/rb/packetgen)
-[![Action status](https://github.com/lemontree55/packetgen/workflows/ci/badge.svg?branch=master)](https://github.com/lemontree55/packetgen/actions?query=workflow%3Aci)
+[![Action status](https://github.com/lemontree55/packetgen/actions/workflows/ci.yml/badge.svg)](https://github.com/lemontree55/packetgen/actions/workflows/ci.yml)
 
 # PacketGen
 

data/lib/packetgen/deprecation.rb

@@ -29,7 +29,13 @@ module PacketGen
     def self.deprecated(klass, deprecated_method, new_method=nil, klass_method: false, remove_version: REMOVE_VERSION)
       base_name = "#{klass}#{klass_method ? '.' : '#'}"
       complete_deprecated_method_name = "#{base_name}#{deprecated_method}"
-      complete_new_method_name = "#{base_name}#{new_method}" unless new_method.nil?
+      unless new_method.nil?
+        complete_new_method_name = if %w[# .].any? { |punct| new_method.include?(punct) }
+                                     new_method
+                                   else
+                                     "#{base_name}#{new_method}"
+                                   end
+      end
 
       file, line = caller(2..2).first.split(':')[0, 2]
       message = "#{file}:#{line}: #{complete_deprecated_method_name} is deprecated"

data/lib/packetgen/header/arp.rb

@@ -9,9 +9,9 @@
 module PacketGen
   module Header
     # An ARP header consists of:
-    # * a hardware type ({#hrd} or {#htype}) field ({BinStruct::Int16}),
+    # * a hardware type ({#hrd} or {#htype}) field (+BinStruct::Int16+),
     # * a protocol type ({#pro} or {#ptype}) field (+Int16+),
-    # * a hardware address length ({#hln} or {#hlen}) field ({BinStruct::Int8}),
+    # * a hardware address length ({#hln} or {#hlen}) field (+BinStruct::Int8+),
     # * a protocol address length ({#pln} or {#plen}) field (+Int8+),
     # * a {#opcode} (or {#op}) field (+Int16+),
     # * a source hardware address ({#sha} or {#src_mac}) field ({Eth::MacAddr}),
@@ -20,13 +20,13 @@ module PacketGen
     # * a target protocol address ({#tpa} or {#dst_ip}) field (+IP::Addr+),
     # * and a {#body}.
     #
-    # == Create a ARP header
+    # @example Create a ARP header
     #  # standalone
     #  arp = PacketGen::Header::ARP.new
     #  # in a packet
     #  pkt = PacketGen.gen('Eth').add('ARP')
     #  # access to ARP header
-    #  pkt.arp   # => PacketGen::Header::ARP
+    #  pkt.arp.protocol_name   # => "ARP"
     #
     # @author Sylvain Daubert
     class ARP < Base
@@ -122,8 +122,7 @@ module PacketGen
 
       private
 
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def handle_options(options)
+            def handle_options(options)
         options[:hrd] ||= options[:htype]
         options[:pro] ||= options[:ptype]
         options[:hln] ||= options[:hlen]
@@ -134,7 +133,7 @@ module PacketGen
         options[:tha] ||= options[:dst_mac]
         options[:tpa] ||= options[:dst_ip]
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:enable Metrics
 
       def invert_addresses
         self.spa, self.tpa = self.tpa, self.spa

data/lib/packetgen/header/asn1_base.rb

@@ -21,7 +21,7 @@ module PacketGen
       include Headerable
 
       class << self
-        # Define some methods from given ASN.1 attributes.to mimic {Base} attributes
+        # Define some methods from given ASN.1 attributes to mimic {Base} attributes
         # @param [Array<Symbol>] attributes
         # @return [void]
         def define_attributes(*attributes)
@@ -32,6 +32,7 @@ module PacketGen
           end
         end
 
+        # @return [Hash]
         def known_headers
           @known_headers ||= {}.freeze
         end

data/lib/packetgen/header/base.rb

@@ -13,8 +13,10 @@ module PacketGen
     #    * +#calc_checksum+, which computes header checksum,
     #    * +#calc_length+, which computes header length,
     #    * {#parse?},
-    #    * +#reply!+, which inverts needed attributes.to forge a response.
+    #    * +#reply!+, which inverts needed attributes to forge a response.
+    # {Base} class defines {.bind} method, to bind headers to outer ones.
     # @author Sylvain Daubert
+    # @author LemonTree55
     class Base < BinStruct::Struct
       include Headerable
 
@@ -54,7 +56,7 @@ module PacketGen
       # @api private
       # Class to handle a header association from procs
       class ProcBinding
-        # @param [Array<Proc>] procs first proc is used to set fields, second proc is
+        # @param [Array(Proc,Proc)] procs first proc is used to set fields, second proc is
         #  used to check binding
         def initialize(procs)
           @set = procs.shift
@@ -77,11 +79,11 @@ module PacketGen
       end
 
       # @api private
-      # Class to handle header associations
+      # Class to handle a set of header associations ({Binding} or/and {ProcBinding})
       class Bindings
         include Enumerable
 
-        # @return [Array<Binding>]
+        # @return [Array<Binding,ProcBinding>]
         attr_accessor :bindings
 
         def initialize
@@ -92,7 +94,7 @@ module PacketGen
           @bindings << []
         end
 
-        # @param [Object] arg
+        # @param [Binding,ProcBinding] arg
         # @return [Bindings] self
         def <<(arg)
           @bindings.last << arg
@@ -100,6 +102,7 @@ module PacketGen
 
         # each iterator
         # @return [void]
+        # @yieldparam [Binding,ProcBinding] binding
         def each(&block)
           @bindings.each(&block)
         end
@@ -109,7 +112,7 @@ module PacketGen
           @bindings.empty?
         end
 
-        # Return binding as a hash.
+        # Return bindings as a hash.
         # @return [Hash]
         def to_h
           hsh = {}
@@ -146,12 +149,12 @@ module PacketGen
       class << self
         # @api private
         # Get known headers
-        # @return [Hash] keys: header classes, values: hashes
+        # @return [Hash{Headerable => Bindings}]
         attr_reader :known_headers
 
         # Bind a upper header to current one.
         # @param [Class] header_klass header class to bind to current class
-        # @param [Hash] args current class attributes.and their value when +header_klass+
+        # @param [Hash] args current class attributes and their value when +header_klass+
         #   is embedded in current class.
         #
         #   Given value may be a lambda, whose alone argument is the value extracted
@@ -163,23 +166,23 @@ module PacketGen
         #   non-trivial checks should be made.
         # @return [void]
         # @example Basic examples
-        #   # Bind Header2 to Header1 when field1 from Header1 has a value of 42
-        #   Header1.bind Header2, field1: 42
-        #   # Bind Header3 to Header1 when field1 from Header1 has a value of 43
-        #   # and field2 has value 43 or 44
-        #   Header1.bind Header3, field1: 43, field2: 43
-        #   Header1.bind Header3, field1: 43, field2: 44
+        #   # Bind TCP to IP when protocol attribute from IP has a value of 66
+        #   PacketGen::Header::IP.bind PacketGen::Header::TCP, protocol: 66
+        #   # Bind UDP to IP when protocol from IP has a value of 177
+        #   # and tos has value 43 or 44
+        #   PacketGen::Header::IP .bind PacketGen::Header::UDP, protocol: 177, tos: 43
+        #   PacketGen::Header::IP .bind PacketGen::Header::UDP, protocol: 177, tos: 44
         # @example Defining a binding on a field using a lambda.
-        #   # Bind Header4 to Header1 when field1 from Header1 has a value
-        #   # greater or equal to 44. When adding a Header2 to a Header1
+        #   # Bind DHCP to Eth when ethertype from Eth has a value
+        #   # greater or equal to 44. When adding a DHCP to a Eth
         #   # with Packet#add, force value to 44.
-        #   Header1.bind Header4, field1: ->(v) { v.nil? ? 44 : v >= 44 }
+        #   PacketGen::Header::Eth.bind PacketGen::Header::DHCP, ethertype: ->(v) { v.nil? ? 44 : v >= 44 }
         # @example Defining a binding using procs key
-        #   # Bind Header5 to Header1 when field1 from Header1 has a value of 41
-        #   # and first two bytes of header1's body are null.
-        #   # When adding a Header2 to a Header1 with Packet#add, force value to 44.
-        #   Header1.bind Header5, procs: [->(hdr) { hdr.field1 = 41 }
-        #                                 ->(hdr) { hdr.field1 == 41 && hdr.body[0..1] == "\x00\x00" }]
+        #   # Bind IPv6 to IP when protocol from IP has a value of 255
+        #   # and first two bytes of IP's body are 0x6000.
+        #   # When adding a IPv6 to a IP with Packet#add, force value to 255.
+        #   PacketGen::Header::IP.bind PacketGen::Header::IPv6, procs: [->(hdr) { hdr.protocol = 255 },
+        #                                                               ->(hdr) { hdr.protocol == 255 && hdr.body[0..1] == "\x60\x00" }]
         # @since 2.7.0
         def bind(header_klass, args={})
           bindings = @known_headers[header_klass]
@@ -221,7 +224,7 @@ module PacketGen
       # @api private
       # Get +header+ id in {Packet#headers} array
       # @param [Header] header
-      # @return [Integer]
+      # @return [Integer] header id
       # @raise [FormatError] +header+ not in a packet
       def header_id(header)
         raise FormatError, "header of type #{header.class} not in a packet" if packet.nil?
@@ -247,7 +250,7 @@ module PacketGen
       end
 
       # @api private
-      # Get link layer header from given header
+      # Get link layer ({Eth} or {Dot11}) header from given header
       # @param [Header] header
       # @return [Header]
       # @raise [FormatError] no link layer header in packet

data/lib/packetgen/header/bootp.rb

@@ -12,31 +12,31 @@ module PacketGen
     # RFC 951}
     #
     # A BOOTP header consists of:
-    # * an operation code field ({#op} of type {BinStruct::Int8Enum}),
-    # * a hardware address type ({#htype} of type {BinStruct::Int8}),
-    # * a hardware address length ({#hlen} of type {BinStruct::Int8}),
-    # * a {#hops} field ({BinStruct::Int8}),
-    # * a transaction ID ({#xid} of type {BinStruct::Int32}),
-    # * a {#secs} field (){BinStruct::Int16}),
-    # * a {#flags} field (){BinStruct::Int16}):
+    # * an operation code field ({#op} of type +BinStruct::Int8Enum+),
+    # * a hardware address type ({#htype} of type +BinStruct::Int8+),
+    # * a hardware address length ({#hlen} of type +BinStruct::Int8+),
+    # * a {#hops} field (+BinStruct::Int8+),
+    # * a transaction ID ({#xid} of type +BinStruct::Int32+),
+    # * a {#secs} field (+BinStruct::Int16+),
+    # * a {#flags} field (+BinStruct::Int16+):
     #   * a 1-bit broadcast flag ({#b}),
     #   * a 15-bit Must Be Zero field ({#mbz}),
     # * a {#ciaddr} field ({IP::Addr}),
     # * a {#yiaddr} field ({IP::Addr}),
     # * a {#siaddr} field ({IP::Addr}),
     # * a {#giaddr} field ({IP::Addr}),
-    # * a {#chaddr} field (16-byte {BinStruct::String}),
-    # * a {#sname} field (64-byte {BinStruct::CString}),
-    # * a {#file} field (128-byte {BinStruct::CString}),
-    # * and a body ({BinStruct::String}).
+    # * a {#chaddr} field (16-byte +BinStruct::String+),
+    # * a {#sname} field (64-byte +BinStruct::CString+),
+    # * a {#file} field (128-byte +BinStruct::CString+),
+    # * and a body (+BinStruct::String+).
     #
-    # == Create a BOOTP header
+    # @example Create a BOOTP header
     #   # standalone
     #   bootp = PacketGen::Header::BOOTP.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP').add('BOOTP')
+    #   pkt = PacketGen.gen('IP').add('UDP').add('BOOTP')
     #   # access to BOOTP header
-    #   pkt.bootp      # => PacketGen::Header::BOOTP
+    #   pkt.bootp.protocol_name      # => "BOOTP"
     # @author Sylvain Daubert
     # @since 2.2.0
     class BOOTP < Base

data/lib/packetgen/header/dhcp/option.rb

@@ -58,12 +58,12 @@ module PacketGen
       }.freeze
 
       # @!parse
-      #  # Option class with string value. {#type #type} and {#length #length} are
-      #  # {BinStruct::Int8}.
+      #  # Option class with string value. +#type+ and +#length+ are
+      #  # +BinStruct::Int8+.
       #  #
-      #  # See also {IPAddrOption}, {Int8Option}, {Int16Option} and {Int32Option}.
+      #  # See also specialized {IPAddrOption}, {Int8Option}, {Int16Option} and {Int32Option}.
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class Option < BinStruct::AbstractTLV; end
       # @private
       Option = BinStruct::AbstractTLV.create
@@ -71,7 +71,7 @@ module PacketGen
       # @!parse
       #  # {Option} class with IP address value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class IPAddrOption < BinStruct::AbstractTLV; end
       # @private
       IPAddrOption = BinStruct::AbstractTLV.create(value_class: IP::Addr)
@@ -79,7 +79,7 @@ module PacketGen
       # @!parse
       #  # {Option} class with int8 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class Int8Option < BinStruct::AbstractTLV; end
       # @private
       Int8Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int8)
@@ -87,7 +87,7 @@ module PacketGen
       # @!parse
       #  # {Option} class with int16 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of {+inStruct::AbstractTLV+
       #  class Int16Option < BinStruct::AbstractTLV; end
       # @private
       Int16Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int16)
@@ -95,7 +95,7 @@ module PacketGen
       # @!parse
       #  # {Option} class with int32 value
       #  # @since 2.2.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class Int32Option < BinStruct::AbstractTLV; end
       # @private
       Int32Option = BinStruct::AbstractTLV.create(value_class: BinStruct::Int32)

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

@@ -9,9 +9,9 @@
 module PacketGen
   module Header
     class DHCP
-      # Container class for {Option DHCP Options}.
+      # Container class for {Option DHCP Options}. Accepted options are listed on {DHCP::DHCP_OPTIONS}.
       #
-      # == Add DHCP options to an +Options+ instance
+      # @example Add DHCP options to an +Options+ instance
       #   options = PacketGen::Header::DHCP::Options.new
       #   # Add a lease_time option
       #   options << { type: 'lease_time', value: 3600 }

data/lib/packetgen/header/dhcp.rb

@@ -12,22 +12,21 @@ module PacketGen
     # RFC 2131}
     #
     # A DHCP header is quite simple. It is composed of:
-    # * a {#magic} field ({BinStruct::Int32}) to retrieve it in a BOOTP header,
-    # * a, {#options} field ({Options} type, which is a collection of DHCP
+    # * a {#magic} field (+BinStruct::Int32+) to retrieve it in a BOOTP header,
+    # * a {#options} field ({Options} type, which is a collection of DHCP
     #   options).
     #
     # In PacketGen, a DHCP header is always a secondary header after {BOOTP} one.
     #
-    # == Create a DHCP header
+    # @example Create a DHCP header
     #   # standalone
     #   dhcp = PacketGen::Header::DHCP.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP').add('BOOTP').add('DHCP')
+    #   pkt = PacketGen.gen('IP').add('UDP').add('BOOTP').add('DHCP')
     #   # access to DHCP header
-    #   pkt.dhcp      # => PacketGen::Header::DHCP
+    #   pkt.dhcp.class      # => PacketGen::Header::DHCP
     #
-    # == Add options
-    # Options may be added these ways:
+    # @example Add options to a DHCP header
     #   dhcp = PacketGen::Header::DHCP.new
     #   # Add a lease_time option
     #   dhcp.options << { type: 'lease_time', value: 3600 }

data/lib/packetgen/header/dhcpv6/duid.rb

@@ -25,7 +25,7 @@ module PacketGen
         #  @return [Integer]
         define_attr :type, BinStruct::Int16Enum, enum: TYPES
         # @!attribute body
-        #  @abstract replaced by specific attributes.in subclasses
+        #  @abstract replaced by specific attributes in subclasses
         #  DUID data.
         #  @return [String]
         define_attr :body, BinStruct::String

data/lib/packetgen/header/dhcpv6/option.rb

@@ -9,10 +9,10 @@
 module PacketGen
   module Header
     class DHCPv6
-      # A DHCPv6 consists of:
-      # * a {#type} ({BinStruct::Int16}),
-      # * a {#length} ({BinStruct::Int16}),
-      # * and a {#data} ({BinStruct::String}).
+      # A DHCPv6 option consists of:
+      # * a {#type} (+BinStruct::Int16+),
+      # * a {#length} (+BinStruct::Int16+),
+      # * and a {#data} (+BinStruct::String+).
       #
       # Subclasses handles known options. These subclasses may remove {#data}
       # field to replace it by specific option field(s).
@@ -25,9 +25,10 @@ module PacketGen
         #  @return [Integer]
         define_attr :type, BinStruct::Int16
         # @!attribute length
-        #  16-bit option length
+        #  16-bit option length. Length of data part.
         #  @return [Integer]
         define_attr :length, BinStruct::Int16
+        # @!scope class
         # @!attribute data
         #  variable length option data.
         #  @return [String]
@@ -216,13 +217,6 @@ module PacketGen
         end
       end
 
-      # List of requested options for {ORO} option.
-      # Set of {BinStruct::Int16}
-      # @author Sylvain Daubert
-      class RequestedOptions < BinStruct::Array
-        set_of BinStruct::Int16
-      end
-
       # DHCPv6 Option Request Option
       # @author Sylvain Daubert
       class ORO < Option
@@ -230,8 +224,10 @@ module PacketGen
         remove_attr :data
 
         # @!attribute options
-        #   @return [RequestedOptions]
-        define_attr :options, RequestedOptions, builder: ->(h, t) { t.new(length_from: h[:length]) }
+        #   @return [BinStruct::ArrayOfInt16]
+        #   @since 2.5.0
+        #   @since 4.1.0 Type +BinStruct::ArrayOfInt16+ instead of custom +RequestedOptions+ (deleted)
+        define_attr :options, BinStruct::ArrayOfInt16, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         # Get human-readable data
         # @return [String]
@@ -280,6 +276,9 @@ module PacketGen
       # @author Sylvain Daubert
       class RelayMessage < Option
         update_attr :type, default: 9
+        # @!attribute data
+        #  variable length option data.
+        #  @return [String]
       end
 
       # DHCPv6 Server Unicast option
@@ -302,8 +301,31 @@ module PacketGen
 
       # DHCPv6 Status Code option
       # @author Sylvain Daubert
-      class StatusCode < ElapsedTime
+      class StatusCode < Option
         update_attr :type, default: 13
+        remove_attr :data
+
+        # @!attribute status_code
+        #  16-bit status code
+        #  @return [Integer]
+        define_attr :status_code, BinStruct::Int16
+        # @!attribute status_message
+        #  UTF-8 encoded text string suitable for display to an end user
+        #  @return [::String]
+        define_attr :status_message, BinStruct::String
+
+        # @param [Hash] options
+        def initialize(options={})
+          options[:length] = options[:status_message].to_s.size + 2 if options[:status_message]
+          super
+          self.length = self.sz - 4 if options[:status_message].nil?
+        end
+
+        # Get human-readable data (status code)
+        # @return [String]
+        def human_data
+          status_code.to_s
+        end
       end
 
       # DHCPv6 Rapid Commit option

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

@@ -11,8 +11,8 @@ module PacketGen
     class DHCPv6
       # Container class for DHCPv6 {Option options}.
       #
-      # == Add DHCPv6 options to an +Options+ instance
-      #   options = PacketGen::Header::DHCP::Options.new
+      # @example Add DHCPv6 options to an +Options+ instance
+      #   options = PacketGen::Header::DHCPv6::Options.new
       #   # Add an ElapsedTime option
       #   options << { type: 'ElapsedTime', value: 3600 }
       #   # Add a ClientID. Here, use integer type
@@ -22,7 +22,7 @@ module PacketGen
       class Options < BinStruct::Array
         set_of DHCPv6::Option
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
 
         private

data/lib/packetgen/header/dhcpv6/relay.rb

@@ -38,6 +38,7 @@ module PacketGen
         #   @return [IPv6::Addr]
         define_attr :peer, IPv6::Addr
         # @!attribute options
+        #   Set of {Option}s
         #   @return [DHCPv6::Options]
         define_attr :options, DHCPv6::Options
       end

data/lib/packetgen/header/dhcpv6.rb

@@ -22,22 +22,20 @@ module PacketGen
     #   |                                                               |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A DHCPv6 header is made of:
-    # * a {#msg_type} field ({BinStruct::Int8Enum}),
-    # * a {#transaction_id} field ({BinStruct::Int24}),
-    # * and an {#options} field ({DHCPv6::Options}).
+    # * a {#msg_type} field (+BinStruct::Int8Enum+),
+    # * a {#transaction_id} field (+BinStruct::Int24+),
+    # * and an {#options} field ({DHCPv6::Options}). This field is a container for {DHCPv6::Option} objects.
     #
-    # == Create a DHCPv6 header
+    # @example Create a DHCPv6 header
     #   # standalone
-    #  dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
-    #  # in a packet
-    #  pkt = PacketGen.gen('IPv6').add('DHCPv6', msg_type: 'SOLLICIT')
-    #  # access to DHCPv6 header from packet
-    #  pkt.dhcpv6    #=> PacketGen::Header::DHCPv6
-    #
-    # == Add options
-    # DHCPv6 options are defined by subclasses of {DHCPv6::Option}.
+    #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
+    #   # in a packet
+    #   pkt = PacketGen.gen('IPv6').add('UDP').add('DHCPv6', msg_type: 'SOLLICIT')
+    #   # access to DHCPv6 header from packet
+    #   pkt.dhcpv6.class    #=> PacketGen::Header::DHCPv6
     #
-    # Options may be added by pushing a hash to {#options}:
+    # @example Add options
+    #   # Options may be added by pushing a hash to #options:
     #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
     #   dhcpv6.options << { type: 'Preference', value: 1 }
     # @author Sylvain Daubert
@@ -75,9 +73,10 @@ module PacketGen
       define_attr :msg_type, BinStruct::Int8Enum, enum: MESSAGE_TYPES
       # @!attribute transaction_id
       #   24-bit transaction ID
-      # @return [Integer]
+      #   @return [Integer]
       define_attr :transaction_id, BinStruct::Int24
       # @!attribute options
+      #   Set of {Option}s
       #   @return [DHCPv6::Options]
       define_attr :options, DHCPv6::Options
 

data/lib/packetgen/header/dns/name.rb

@@ -9,13 +9,14 @@
 module PacketGen
   module Header
     class DNS
-      # DNS Name, defined as a suite of labels. A label is of type {BinStruct::IntString}.
+      # DNS Name, defined as a suite of labels. A label is of type +BinStruct::IntString+.
       # @author Sylvain Daubert
       # @author LemonTree55
       class Name < BinStruct::Array
         # Mask to decode a pointer on another label
         POINTER_MASK = 0xc000
 
+        # DNS message to which this name is attached. Used to decode compressed names
         # @return [DNS]
         attr_accessor :dns
 
@@ -49,32 +50,32 @@ module PacketGen
         end
 
         # Clear name
-        #   @return [void]
+        # @return [void]
         def clear
           super
           @pointer = nil
           @pointer_name = nil
         end
 
-        # Read a sequence of label from a string
+        # Read a sequence of label from a binary string
         # @param [String] str binary string
         # @return [Name] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary(str)
+          strb = str.to_s.b
           start = 0
           loop do
-            index = str[start, 2].unpack1('n')
+            index = strb[start, 2].unpack1('n')
             if pointer?(index)
               # Pointer on another label
-              @pointer = str[start, 2]
+              @pointer = strb[start, 2]
               break
             else
-              label = add_label_from(str[start..])
+              label = add_label_from(strb[start..])
               start += label.sz
-              break if label.empty? || str[start..].empty?
+              break if label.empty? || strb[start..].empty?
             end
           end
           # force resolution of compressed names

data/lib/packetgen/header/dns/opt.rb

@@ -15,6 +15,7 @@ module PacketGen
       #
       # a OPT record may contain zero or more {Option options} in its {#rdata}.
       # @author Sylvain Daubert
+      # @author LemonTree55
       # @since 1.3.0
       # @since 3.1.1 {#options} is a {ArrayOfOptions}
       class OPT < RR
@@ -118,11 +119,13 @@ module PacketGen
         alias udp_size rrclass
         alias udp_size= rrclass=
 
+        # Get human-readable string for flags
         # @return [String]
         def human_flags
           do? ? 'do' : 'none'
         end
 
+        # Get human-readable string for this OPT
         # @return [String]
         def to_human
           "#{name} #{human_type} UDPsize:#{udp_size} " \