packetgen 4.0.0 → 4.1.1

data/lib/packetgen/header/icmpv6.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.
@@ -15,30 +15,31 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMPv6 header consists of:
-    # * a +type+ field ({BinStruct::Int8} type),
-    # * a +code+ field ({BinStruct::Int8} type),
-    # * a +checksum+ field ({BinStruct::Int16} type),
-    # * and a +body+.
+    # * a {#type #type} field (+BinStruct::Int8+ type),
+    # * a {#code #code} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}.
     #
-    # == Create a ICMPv6 header
+    # @example Create a ICMPv6 header
     #  # standalone
     #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  # in a packet
     #  pkt = PacketGen.gen('IPv6').add('ICMPv6')
     #  # access to ICMPv6 header
-    #  pkt.icmpv6     # => PacketGen::Header::ICMPv6
+    #  pkt.icmpv6.class  # => PacketGen::Header::ICMPv6
     #
-    # == ICMPv6 attributes
+    # @example ICMPv6 attributes
+    #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  icmpv6.code = 0
     #  icmpv6.type = 200
     #  icmpv6.checksum = 0x248a
-    #  icmpv6.body.read 'this is a body'
+    #  icmpv6.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMPv6 < ICMP
       # ICMPv6 internet protocol number
       IP_PROTOCOL = 58
 
-      # Compute checksum and set +checksum+ field
+      # Compute IPV6-style checksum and set +checksum+ field
       # @return [Integer]
       def calc_checksum
         sum = ip_header(self).pseudo_header_checksum

data/lib/packetgen/header/igmp.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.
@@ -20,25 +20,29 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({BinStruct::Int8Enum} type),
-    # * a {#max_resp_time} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
+    # * a {#type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * a {#group_addr} field ({Header::IP::Addr} type),
     # * and a {#body} (unused for IGMPv2).
     #
-    # == Create a IGMP header
+    # After adding a IGMP header to a packet, you have to call {#igmpize} to ensure
+    # resulting packet conforms to RFC 2236.
+    #
+    # @example Create a IGMP header
     #  # standalone
     #  igmp = PacketGen::Header::IGMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMP')
     #  # access to IGMP header
-    #  pkt.igmp    # => PacketGen::Header::IGMP
+    #  pkt.igmp.class  # => PacketGen::Header::IGMP
     #
-    # == IGMP attributes
-    #  icmp.type = 'MembershipQuery'   # or 0x11
-    #  icmp.max_resp_time = 20
-    #  icmp.checksum = 0x248a
-    #  icmp.group_addr = '224.0.0.1'
+    # @example IGMP attributes
+    #  igmp = PacketGen::Header::IGMP.new
+    #  igmp.type = 'MembershipQuery'   # or 0x11
+    #  igmp.max_resp_time = 20
+    #  igmp.checksum = 0x248a
+    #  igmp.group_addr = '224.0.0.1'
     # @author Sylvain Daubert
     # @since 2.4.0
     class IGMP < Base
@@ -70,12 +74,14 @@ module PacketGen
       #  @return [IP::Addr]
       define_attr :group_addr, IP::Addr, default: '0.0.0.0'
       # @!attribute body
+      #  IGMP body (not used in IGMPv2)
       #  @return [String,Base]
       define_attr :body, BinStruct::String
 
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      #   Define +#igmpize+ method onto +packet+. This method calls {#igmpize}.
       def added_to_packet(packet)
         igmp_idx = packet.headers.size
         packet.instance_eval "def igmpize() @headers[#{igmp_idx}].igmpize; end" # def igmpize() @headers[2].igmpize; end
@@ -103,6 +109,11 @@ module PacketGen
       #    pkt.igmp.igmpize
       #    # second method
       #    pkt.igmpize
+      # @example
+      #   pkt = PacketGen.gen('IP').add('IGMP', type: 'MembershipQuery', max_resp_time: 20, group_addr: '1.2.3.4')
+      #   pkt.igmpize
+      #   pkt.ip.ttl     #=> 1
+      #   pkt.ip.options.map(&:class) #=> [PacketGen::Header::IP::RA]
       # @return [void]
       def igmpize
         iph = ip_header(self)

data/lib/packetgen/header/igmpv3/group_record.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,7 +11,7 @@ module PacketGen
     class IGMPv3
       # Class to handle IGMPv3 Group Records.
       #
-      # A Group Record is a block of attributes.containing information
+      # A Group Record is a block of attributes containing information
       # pertaining to the sender's membership in a single multicast group on
       # the interface from which the Report is sent.
       #
@@ -76,14 +76,19 @@ module PacketGen
         define_attr :source_addr, IP::ArrayOfAddr,
                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
         # @!attribute aux_data
+        #    Not used in IGMPv3
         #  @return [String]
         define_attr :aux_data, BinStruct::String,
                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
+        # Human-readable type
+        # @return [String]
         def human_type
           self[:type].to_human
         end
 
+        # Human-readable description of a group record
+        # @return [String]
         def to_human
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
@@ -94,7 +99,7 @@ module PacketGen
       class GroupRecords < BinStruct::Array
         set_of GroupRecord
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
       end
     end

data/lib/packetgen/header/igmpv3/mq.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.
@@ -49,7 +49,7 @@ module PacketGen
         #  First 8-bit field, composed of {#resv}, {#flag_s} and {#qrv}
         #  @return [Integer]
         # @!attribute resv
-        #  4-bit reserved field in
+        #  4-bit reserved field
         #  @return [Integer]
         # @!attribute flag_s
         #  1-bit S flag (Suppress Router-Side Processing)

data/lib/packetgen/header/igmpv3/mr.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.
@@ -48,7 +48,7 @@ module PacketGen
       class MR < Base
         # @!attribute reserved
         #  16-bit reserved field
-        # @return [Integer]
+        #  @return [Integer]
         define_attr :reserved, BinStruct::Int16, default: 0
         # @!attribute number_of_gr
         #  16-bit Number of group records in {#group_records}

data/lib/packetgen/header/igmpv3.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.
@@ -18,23 +18,24 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({BinStruct::Int8Enum} type),
-    # * a {#max_resp_time} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
-    # * and a {#body}, containing more fields (see below).
+    # * a {#type #type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time #max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}, containing more fields (see below).
     #
-    # A IGMPv3 header may have additionnal fields. These attributes.are handled by
+    # A IGMPv3 header may have additionnal fields. These attributes are handled by
     # additional headers (see {IGMPv3::MQ}).
     #
-    # == Create a IGMPv3 header
+    # @example Create a IGMPv3 header
     #  # standalone
     #  igmp = PacketGen::Header::IGMPv3.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMPv3')
     #  # access to IGMPv3 header
-    #  pkt.igmp    # => PacketGen::Header::IGMPv3
+    #  pkt.igmpv3.class  # => PacketGen::Header::IGMPv3
     #
-    # == IGMPv3 attributes
+    # @example IGMPv3 attributes
+    #  igmp = PacketGen::Header::IGMPv3.new
     #  igmp.type = 'MembershipQuery'   # or 0x11
     #  igmp.max_resp_time = 20
     #  igmp.checksum = 0x248a
@@ -50,14 +51,14 @@ module PacketGen
     #   igmp.max_resp_code   #=> 9728  error due to encoding as a floating point value
     #
     # === IGMPv3 Membership Query
-    # With IGMPv3, a Membership Query packet has more attributes.than with IGMPv2. To
+    # With IGMPv3, a Membership Query packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt = PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MQ')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
     #   pkt.igmpv3_mq   #=> PacketGen::Header::IGMPv3::MQ
     #
     # === IGMPv3 Membership Report
-    # With IGMPv3, a Membership Report packet has more attributes.than with IGMPv2. To
+    # With IGMPv3, a Membership Report packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt =  PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MR')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3

data/lib/packetgen/header/ip/addr.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.
@@ -18,7 +18,7 @@ module PacketGen
         #  @return [Integer] IP address first byte
         define_attr :a1, BinStruct::Int8
         # @!attribute a2
-        #  @return [Integer] IP address seconf byte
+        #  @return [Integer] IP address second byte
         define_attr :a2, BinStruct::Int8
         # @!attribute a3
         #  @return [Integer] IP address third byte
@@ -27,6 +27,7 @@ module PacketGen
         #  @return [Integer] IP address fourth byte
         define_attr :a4, BinStruct::Int8
 
+        ## Regex to match IPv4 addresses
         IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
 
         # Read a dotted address
@@ -51,7 +52,7 @@ module PacketGen
           attributes.map { |f| self[f].to_i.to_s }.join('.')
         end
 
-        # Addr as an integer
+        # Addr as a 32-bit integer
         # @return [Integer]
         def to_i
           (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
@@ -64,6 +65,9 @@ module PacketGen
           self.a1 >= 224 && self.a1 <= 239
         end
 
+        # Check equality.
+        # Equal is other has same class and all attributes are equal.
+        # @return [Boolean]
         def ==(other)
           other.is_a?(self.class) &&
             attributes.all? { |attr| self[attr].value == other[attr].value }

data/lib/packetgen/header/ip/option.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.
@@ -17,7 +17,11 @@ module PacketGen
         # Push a IP address to the array
         # @param [String,Addr] addr
         # @return [self]
+        # @example
+        #   array = PacketGen::Header::IP::ArrayOfAddr.new
+        #   # #<< uses #push internally
         #   array << '192.168.1.12'
+        #   array.push(PacketGen::Header::IP::Addr.new.from_human('192.18.1.13'))
         def push(addr)
           addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super
@@ -46,7 +50,7 @@ module PacketGen
 
         # @!attribute type
         #  8-bit option type
-        # @return [Integer]
+        #  @return [Integer]
         # @!attribute copied
         #  1-bit copied flag from {#type} field
         #  @return [Integer]
@@ -60,15 +64,17 @@ module PacketGen
         define_bit_attr :type, copied: 1, option_class: 2, number: 5
         # @!attribute length
         #  8-bit option length. If 0, there is no +length+ field in option
-        # @return [Integer]
+        #  @return [Integer]
         define_attr :length, BinStruct::Int8, default: 0, optional: ->(h) { h.type > 1 }
         # @!attribute data
         #  option data
-        # @return [String]
+        #  @return [String]
         define_attr :data, BinStruct::String, optional: ->(h) { h.length > 2 },
                                               builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
-        # @return [Hash]
+        # @private
+        # Return a cached hash associating type name to its value.
+        # @return [Hash{String => Integer}]
         def self.types
           return @types if defined? @types
 
@@ -83,6 +89,7 @@ module PacketGen
         end
 
         # Factory to build an option from its type
+        # @param [Hash] options
         # @return [Option]
         def self.build(options={})
           type = options[:type]
@@ -96,6 +103,8 @@ module PacketGen
           klass.new(options)
         end
 
+        # Force type value for subclasses, if not specified
+        # @return [Option]
         def initialize(options={})
           options[:type] = class2type unless options[:type]
 
@@ -153,7 +162,7 @@ module PacketGen
         remove_attr :data
 
         # @!attribute pointer
-        #  8-bit pointer on next address
+        #  8-bit po+++inter on next address
         #  @return [Integer]
         define_attr :pointer, BinStruct::Int8, default: 4
         # @!attribute data
@@ -190,6 +199,8 @@ module PacketGen
         #  @return [Integer]
         define_attr :id, BinStruct::Int16
 
+        # Return a human-readable string
+        # @return [String]
         def to_human
           super << ":#{self.id}"
         end
@@ -204,6 +215,8 @@ module PacketGen
         #  @return [Integer]
         define_attr :value, BinStruct::Int16, default: 0
 
+        # Return a human-readable string
+        # @return [String]
         def to_human
           super << ":#{self.value}"
         end

data/lib/packetgen/header/ip/options.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/header/ip.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.
@@ -27,32 +27,33 @@ module PacketGen
     #   |                    Options                    |    Padding    |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A IP header consists of:
-    # * a first byte ({#u8} of {BinStruct::Int8} type) composed of:
+    # * a first byte ({#u8} of +BinStruct::Int8+ type) composed of:
     #   * a 4-bit {#version} field,
     #   * a 4-bit IP header length ({#ihl}) field,
-    # * a Type of Service field ({#tos}, {BinStruct::Int8} type),
-    # * a total length ({#length}, {BinStruct::Int16} type),
-    # * a ID ({#id}, +Int16+ type),
-    # * a {#frag} worg (+Int16+) composed of:
+    # * a Type of Service field ({#tos}, +BinStruct::Int8+ type),
+    # * a total length ({#length}, +BinStruct::Int16+ type),
+    # * a ID ({#id}, +BinStruct::Int16+ type),
+    # * a {#frag} worg (+BinStruct::Int16+) composed of:
     #   * 3 1-bit flags ({#flag_rsv}, {#flag_df} and {#flag_mf}),
     #   * a 13-bit {#fragment_offset} field,
     # * a Time-to-Live ({#ttl}) field (+Int8+),
-    # * a {#protocol} field (+Int8+),
-    # * a {#checksum} field (+Int16+),
+    # * a {#protocol} field (+BinStruct::Int8+),
+    # * a {#checksum} field (+BinStruct::Int16+),
     # * a source IP address ({#src}, {Addr} type),
-    # * a destination IP address ({#dst}, +Addr+ type),
+    # * a destination IP address ({#dst}, {Addr} type),
     # * an optional {#options} field ({Options} type),
-    # * and a {#body} ({BinStruct::String} type).
+    # * and a {#body} (+BinStruct::String+ type).
     #
-    # == Create a IP header
+    # @example Create a IP header
     #  # standalone
     #  ip = PacketGen::Header::IP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP')
     #  # access to IP header
-    #  pkt.ip   # => PacketGen::Header::IP
+    #  pkt.ip.class   # => PacketGen::Header::IP
     #
-    # == IP attributes
+    # @example IP attributes
+    #  ip = PacketGen::Header::IP.new
     #  ip.u8 = 0x45
     #  # the same as
     #  ip.version = 4
@@ -66,21 +67,20 @@ module PacketGen
     #  ip.flag_mf = true
     #  ip.fragment_offset = 0x31
     #
-    #  ip.flag_rsv?  # => Boolean
-    #  ip.flag_df?   # => Boolean
-    #  ip.flag_mf?   # => Boolean
+    #  ip.flag_rsv?  # => false
+    #  ip.flag_df?   # => false
+    #  ip.flag_mf?   # => true
     #
     #  ip.ttl = 0x40
     #  ip.protocol = 6
     #  ip.checksum = 0xffff
     #  ip.src = '127.0.0.1'
     #  ip.src                # => "127.0.0.1"
-    #  ip[:src]              # => PacketGen::Header::IP::Addr
+    #  ip[:src].class        # => PacketGen::Header::IP::Addr
     #  ip.dst = '127.0.0.2'
-    #  ip.body.read 'this is a body'
+    #  ip.body = 'this is a body'
     #
-    # == Add IP options
-    # IP has an {#options} attribute used to store datagram options.
+    # @example Add IP options
     #  pkt = PacketGen.gen('IP')
     #  # add option from class
     #  pkt.ip.options << PacketGen::Header::IP::RA.new
@@ -101,52 +101,68 @@ module PacketGen
       #  First byte of IP header. May be accessed through {#version} and {#ihl}.
       #  @return [Integer] first byte of IP header.
       # @!attribute version
-      #   @return [Integer] 4-bit version attribute
+      #   4-bit version attribute
+      #   @return [Integer]
       # @!attribute ihl
-      #   @return [Integer] 4-bit IP header length attribute
+      #   4-bit IP header length attribute, as 32-bit word count.
+      #   Default to 5 (IP header without option).
+      #   @return [Integer]
       define_bit_attr :u8, default: 0x45, version: 4, ihl: 4
       # @!attribute tos
       #   @return [Integer] 8-bit Type of Service self[attr]
       define_attr :tos, BinStruct::Int8, default: 0
       # @!attribute length
-      #   @return [Integer] 16-bit IP total length
+      #   16-bit IP total length, including this header.
+      #   @return [Integer]
       define_attr :length, BinStruct::Int16, default: 20
       # @!attribute id
       #   @return [Integer] 16-bit ID
       define_attr :id, BinStruct::Int16, default: ->(_) { rand(65_535) }
       # @!attribute frag
-      #   @return [Integer] 16-bit frag word
+      #   16-bit frag word
+      #   @return [Integer]
       # @!attribute flag_rsv
-      #   @return [Boolean] reserved bit from flags
+      #   reserved bit from flags
+      #   @return [Boolean]
       # @!attribute flag_df
-      #   @return [Boolean] Don't Fragment flag
+      #   Don't Fragment flag
+      #   @return [Boolean]
       # @!attribute flag_mf
-      #   @return [Boolean] More Fragment flags
+      #   More Fragment flags
+      #   @return [Boolean]
       # @!attribute fragment_offset
-      #   @return [Integer] 13-bit fragment offset
+      #   13-bit fragment offset
+      #   @return [Integer]
       define_bit_attr :frag, flag_rsv: 1, flag_df: 1, flag_mf: 1, fragment_offset: 13
       # @!attribute ttl
-      #   @return [Integer] 8-bit Time To Live self[attr]
+      #   8-bit Time To Live
+      #   @return [Integer]
       define_attr :ttl, BinStruct::Int8, default: 64
       # @!attribute protocol
-      #   @return [Integer] 8-bit upper protocol self[attr]
+      #   8-bit upper protocol
+      #   @return [Integer]
       define_attr :protocol, BinStruct::Int8
       # @!attribute checksum
-      #   @return [Integer] 16-bit IP header checksum
+      #   16-bit IP header checksum
+      #   @return [Integer]
       define_attr :checksum, BinStruct::Int16, default: 0
       # @!attribute src
-      #   @return [Addr] source IP address
+      #   source IP address
+      #   @return [Addr]
       define_attr :src, Addr, default: '127.0.0.1'
       # @!attribute dst
-      #   @return [Addr] destination IP address
+      #   destination IP address
+      #   @return [Addr]
       define_attr :dst, Addr, default: '127.0.0.1'
       # @!attribute options
+      #  IP options
       #  @since 2.2.0
-      #  @return [BinStruct::String]
+      #  @return [Options]
       define_attr :options, Options, optional: ->(h) { h.ihl > 5 },
                                      builder: ->(h, t) { t.new(length_from: -> { (h.ihl - 5) * 4 }) }
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  IP body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       # Helper method to compute sum of 16-bit words. Used to compute IP-style
@@ -224,7 +240,8 @@ module PacketGen
       end
 
       # Check version field
-      # @see [Base#parse?]
+      # @see Base#parse?
+      # @return [Boolean]
       def parse?
         (version == 4) && (ihl >= 5)
       end

data/lib/packetgen/header/ipv6/addr.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.
@@ -14,6 +14,7 @@ module PacketGen
     class IPv6
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
+      # @author LemonTree55
       class Addr < BinStruct::Struct
         include BinStruct::Structable
 
@@ -50,11 +51,10 @@ module PacketGen
         #  @return [Integer]
         define_attr :a8, BinStruct::Int16
 
-        # rubocop:disable Metrics/AbcSize
-
         # Read a colon-delimited address
         # @param [String] str
         # @return [self]
+        # @raise [ArgumentError] not a colon-delimited IPv6 address
         def from_human(str)
           return self if str.nil?
 
@@ -62,19 +62,13 @@ module PacketGen
           raise ArgumentError, 'string is not a IPv6 address' unless addr.ipv6?
 
           addri = addr.to_i
-          self.a1 = addri >> 112
-          self.a2 = addri >> 96 & 0xffff
-          self.a3 = addri >> 80 & 0xffff
-          self.a4 = addri >> 64 & 0xffff
-          self.a5 = addri >> 48 & 0xffff
-          self.a6 = addri >> 32 & 0xffff
-          self.a7 = addri >> 16 & 0xffff
-          self.a8 = addri & 0xffff
+          8.times do |i|
+            self.send(:"a#{i + 1}=", addri >> (16 * (7 - i)) & 0xffff)
+          end
           self
         end
-        # rubocop:enable Metrics/AbcSize
 
-        # Addr6 in human readable form (colon-delimited hex string)
+        # Return IPv6 address in human readable form (colon-delimited hex string)
         # @return [String]
         def to_human
           IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
@@ -92,6 +86,9 @@ module PacketGen
           self.a1 & 0xff00 == 0xff00
         end
 
+        # Check equaliy to +other+.
+        # Equal if other has the same class, and all attributes are equal
+        # @return [Boolean]
         def ==(other)
           other.is_a?(self.class) &&
             attributes.all? { |attr| self[attr].value == other[attr].value }
@@ -106,7 +103,11 @@ module PacketGen
         # Push a IPv6 address to the array
         # @param [String,Addr] addr
         # @return [self]
-        #   array << '2001:1234::125'
+        # @example
+        #   array = PacketGen::Header::IPv6::ArrayOfAddr.new
+        #   # #<< uses #push internally
+        #   array << '2001::1'
+        #   array.push(PacketGen::Header::IPv6::Addr.new.from_human('1:2:3:abcd::1'))
         def push(addr)
           addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super