packetgen 4.0.0 → 4.1.1

data/lib/packetgen/header/eap.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.
@@ -12,34 +12,22 @@ module PacketGen
     # {https://tools.ietf.org/html/rfc3748 RFC 3748}
     #
     # A EAP header has:
-    # * a {#code} field ({BinStruct::Int8Enum}),
-    # * a {#id} field ({BinStruct::Int8}),
-    # * a {#length} field ({BinStruct::Int16}).
+    # * a {#code} field (+BinStruct::Int8Enum+),
+    # * a {#id} field (+BinStruct::Int8+),
+    # * a {#length} field (+BinStruct::Int16+).
     # Request (code 1) and Response (code 2) packets also have:
     # * a {#type} field (+BinStruct::Int8Enum+).
     # And Expanded Types (type 254) packets also have:
-    # * a {#vendor_id} field ({BinStruct::Int24}),
-    # * a {#vendor_type} field ({BinStruct::Int32}).
-    # Finally, all packets have a {#body} ({BinStruct::String}).
-    #
-    # == Create EAP headers
-    # An EAP header may be created this way:
-    #   # create a request header with default type (1)
-    #   eap = EAP.new(code: 1)   # => PacketGen::Header::EAP
-    #   # the same
-    #   eap = EAP.new(code: 'Request')   # => PacketGen::Header::EAP
-    #   # create a Response header of type Nak
-    #   nak = EAP.new(code: 'Response', type: 'Nak')
+    # * a {#vendor_id} field (+BinStruct::Int24+),
+    # * a {#vendor_type} field (+BinStruct::Int32+).
+    # Finally, all packets have a {#body} (+BinStruct::String+).
     #
     # === Specialized headers
     # Some EAP has a specialized class:
-    # * EAP-MD5,
-    # * EAP-TLS,
-    # * EAP-TTLS,
-    # * EAP-FAST.
-    # Creating such a header is fairly simple:
-    #   # Generate a EAP-TLS Response (type is forced to 13)
-    #   eap = EAP::TLS.new(code: 2)     # => PacketGen::Header::EAP::TLS
+    # * EAP-MD5 ({EAP::MD5}),
+    # * EAP-TLS ({EAP::TLS}),
+    # * EAP-TTLS ({EAP::TTLS}),
+    # * EAP-FAST ({EAP::FAST}).
     #
     # == Header accessors
     # EAP headers may be accessed through +Packet#eap+ accessor.
@@ -54,7 +42,29 @@ module PacketGen
     # So result of parsing a EAP header may be a {EAP}, {EAP::MD5}, {EAP::TLS},
     # {EAP::TTLS} or {EAP::FAST} instance. But this instance is still accessible
     # through +Packet#eap+.
+    #
+    # @example Create EAP headers
+    #   # create a request header with default type (1)
+    #   eap = PacketGen::Header::EAP.new(code: 1)
+    #   eap.human_code   #=> 'Request'
+    #   # the same
+    #   eap = PacketGen::Header::EAP.new(code: 'Request')
+    #   eap.code         #=> 1
+    #   # create a Response header of type Nak
+    #   nak = PacketGen::Header::EAP.new(code: 'Response', type: 'Nak')
+    #   nak.code      #=> 2
+    #   nak.type      #=> 3
+    #
+    # @example Create a specialized EAP header
+    #   eap = PacketGen::Header::EAP::TLS.new(code: 2)
+    #   eap.class    #=> PacketGen::Header::EAP::TLS
+    #
+    # @example Parse a specialized class from a binary string
+    #   pkt = PacketGen.parse("\x01\x00\x00\x0e\x04\x04\x00\x01\x02\x03name", first_header: 'EAP')
+    #   pkt.eap.class   # => PacketGen::Header::EAP::MD5
+    #
     # @author Sylvain Daubert
+    # @author LemonTree55
     # @since 2.1.4
     class EAP < Base
       # EAP known codes
@@ -81,41 +91,48 @@ module PacketGen
       }.freeze
 
       # @!attribute code
-      #  @return [Integer] 8-bit EAP code
+      #  8-bit EAP code. See {CODES known EAP codes}
+      #  @return [Integer]
       define_attr :code, BinStruct::Int8Enum, enum: CODES
 
       # @!attribute id
-      #  @return [Integer] 8-bit identifier
+      #  8-bit identifier
+      #  @return [Integer]
       define_attr :id, BinStruct::Int8
 
       # @!attribute length
-      #  @return [Integer] 16-bit length of EAP packet
+      #  16-bit length of EAP packet
+      #  @return [Integer]
       define_attr :length, BinStruct::Int16, default: 4
 
       # @!attribute type
-      #  This field is present only for Request or Response packets,
-      #  with type different from Expanded Types (254).
-      #  @return [Integer] 8-bit request or response type
+      #  8-bit request or response type.
+      #  This field is present only for Request or Response packets.
+      #  See {TYPES known EAP types}.
+      #  @return [Integer]
       define_attr :type, BinStruct::Int8Enum,
                   enum: TYPES,
                   optional: lambda(&:type?)
 
       # @!attribute vendor_id
+      #  24-bit vendor ID.
       #  This field is present only for Request or Response packets,
       #  with type equal to +Expanded Types+ (254).
-      #  @return [Integer] 24-bit vendor ID
+      #  @return [Integer]
       define_attr :vendor_id, BinStruct::Int24,
                   optional: ->(eap) { eap.type? && (eap.type == 254) }
 
       # @!attribute vendor_type
+      #  32-bit vendor type.
       #  This field is present only for Request or Response packets,
       #  with type equal to +Expanded Types+ (254).
-      #  @return [Integer] 32-bit vendor type
+      #  @return [Integer]
       define_attr :vendor_type, BinStruct::Int32,
                   optional: ->(eap) { eap.type? && (eap.type == 254) }
 
       # @!attribute body
-      #  @return [BinStruct::String, Header::Base]
+      #  EAP packet body
+      #  @return [BinStruct::String, Headerable]
       define_attr :body, BinStruct::String
 
       # @return [EAP]
@@ -129,7 +146,7 @@ module PacketGen
 
       # Populate object from a binary string
       # @param [String] str
-      # @return [Dot11] may return a subclass object if a more specific class
+      # @return [EAP] may return a subclass object if a more specific class
       #   may be determined
       def read(str)
         super
@@ -189,11 +206,19 @@ module PacketGen
         code == CODES['Failure']
       end
 
+      # Is packet a NAK?
+      # @return [Boolean]
+      # @since 4.1.0
+      # @author LemonTree55
+      def nak?
+        (code == 2) && (type == 3)
+      end
+
       # Return an array of desired authentication types from a Nak packet
       # @return [Array<Integer>]
       # @raise [ParseError] not a Nak packet
       def desired_auth_type
-        raise ParseError, 'not a Nak response' if (code != 2) && (type != 3)
+        raise ParseError, 'not a Nak response' unless nak?
 
         body.to_s.unpack('C*')
       end

data/lib/packetgen/header/eth.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,26 +10,32 @@ module PacketGen
   module Header
     # An Ethernet header consists of:
     # * a destination MAC address ({MacAddr}),
-    # * a source MAC address (MacAddr),
-    # * a {#ethertype} ({BinStruct::Int16}),
-    # * and a body (a {BinStruct::String} or another Header class).
+    # * a source MAC address ({MacAddr}),
+    # * a {#ethertype} (+BinStruct::Int16+),
+    # * and a body (a +BinStruct::String+ or another {Headerable} class).
     #
-    # == Create a Ethernet header
+    # @example Create a Ethernet header
     #  # standalone
     #  eth = PacketGen::Header::Eth.new
     #  # in a packet
     #  pkt = PacketGen.gen('Eth')
     #  # access to Ethernet header
-    #  pkt.eth   # => PacketGen::Header::Eth
+    #  pkt.eth.class   # => PacketGen::Header::Eth
     #
-    # == Ethernet attributes
+    # @example Access to Ethernet attributes
+    #  eth = PacketGen::Header::Eth.new(src: '00:01:01:01:01:01', ethertype: 0x1234)
+    #  # Set destination MAC address
     #  eth.dst = "00:01:02:03:04:05"
-    #  eth.src        # => "00:01:01:01:01:01"
-    #  eth[:src]      # => PacketGen::Header::Eth::MacAddr
-    #  eth.ethertype  # => 16-bit Integer
+    #  # Access source MAC address, human-redable
+    #  eth.src            # => "00:01:01:01:01:01"
+    #  # Access to MacAddr object
+    #  eth[:src].class    # => PacketGen::Header::Eth::MacAddr
+    #  eth.ethertype      # => 0x1234
+    #  # Set Ethernet body
     #  eth.body = "This is a body"
     #
     # @author Sylvain Daubert
+    # @author LemonTree55
     class Eth < Base
       # Ethernet MAC address, as a group of 6 bytes
       # @author Sylvain Daubert
@@ -58,6 +64,10 @@ module PacketGen
         # Read a human-readable string to populate +MacAddr+
         # @param [String] str
         # @return [self]
+        # @example
+        #   mac = PacketGen::Header::Eth::MacAddr.new
+        #   mac.from_human('01:02:03:04:05:06')
+        #   mac.a5  # => 6
         def from_human(str)
           return self if str.nil?
 
@@ -76,6 +86,8 @@ module PacketGen
           attributes.map { |m| '%02x' % self[m] }.join(':')
         end
 
+        # Equality check. +true+ only if +other+ is a MacAddr, and each address byte is the same.
+        # @return [Boolean]
         def ==(other)
           other.is_a?(self.class) &&
             attributes.all? { |attr| self[attr].value == other[attr].value }
@@ -83,16 +95,18 @@ module PacketGen
       end
 
       # @!attribute dst
-      #  @return [MacAddr] Destination MAC address
+      #  Destination MAC address
+      #  @return [::String]
       define_attr :dst, MacAddr, default: '00:00:00:00:00:00'
       # @!attribute src
-      #  @return [MacAddr] Source MAC address
+      #  Source MAC address
+      #  @return [::String]
       define_attr :src, MacAddr, default: '00:00:00:00:00:00'
       # @!attribute ethertype
       #  @return [Integer] 16-bit integer to determine payload type
       define_attr :ethertype, BinStruct::Int16, default: 0
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       # send Eth packet on wire.

data/lib/packetgen/header/gre.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,21 +20,40 @@ module PacketGen
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #  |                 Sequence Number (Optional)                    |
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # A GRE header is composed of:
+    # * A first 16-bit attribute containing given flags:
+    #   * {#c} indicates if {#checksum} and {#reserved1} attributes are present.
+    #   * {#k} indicates if {#key} attribute is present.
+    #   * {#s} indicatesid {#sequence_number} attribute is present.
+    #   * {#ver} 3-bit version number.
+    # * {#protocol_type} (+BinStruct::Int16+).
+    # * optional {#checksum} and {#reserved1} attribute (both +BinStruct::Int16+).
+    # * optional {#key} attribute (+BinStruct::Int32+).
+    # * optional {#sequence_number} attribute (+BinStruct::Int32+).
+    # * and a {#body} (+BinStruct::String or {Headerable}).
+    #
+    # Current implementation supports tunneling {IP} and {IPv6} packets in GRE.
     # @author Sylvain Daubert
+    # @author LemonTree55
     # @since 2.1.0
     class GRE < Base
       # IP protocol number for GRE
       IP_PROTOCOL = 47
 
       # @!attribute c
+      #   Say if {#checksum} and {#reserved1} attributes are present
       #   @return [Boolean]
       # @!attribute k
+      #   Say if {#key} attribute is present
       #   @return [Boolean]
       # @!attribute s
+      #   Say if {#sequence_number} attribute is present
       #   @return [Boolean]
       # @!attribute reserved0
       #   @return [Integer]
       # @!attribute ver
+      #   3-bit GRE protocol version.
       #   @return [Integer]
       define_bit_attr :u16, c: 1, r: 1, k: 1, s: 1, reserved0: 9, ver: 3
 
@@ -42,19 +61,24 @@ module PacketGen
       #   @return [Integer]
       define_attr :protocol_type, BinStruct::Int16
       # @!attribute checksum
+      #   IP checksum over all 16-bit words in GRE header and its body. Present only if {#c} is set.
       #   @return [Integer]
       define_attr :checksum, BinStruct::Int16, default: 0, optional: lambda(&:c?)
       # @!attribute reserved1
+      #   Reserved field, present only if {#c} is set.
       #   @return [Integer]
       define_attr :reserved1, BinStruct::Int16, default: 0, optional: lambda(&:c?)
       # @!attribute key
+      #   32-bit integer used to identify an individual traffic flow within a tunnel.
+      #   Present only if {#k} is set.
       #   @return [Integer]
       define_attr :key, BinStruct::Int32, optional: lambda(&:k?)
       # @!attribute sequence_number
+      #   32-bit integer. Present only if {#s} is set.
       #   @return [Integer]
       define_attr :sequence_number, BinStruct::Int32, optional: lambda(&:s?)
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #   @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       alias seqnum sequence_number
@@ -65,7 +89,7 @@ module PacketGen
         super(opts)
       end
 
-      # Compute checksum and set +checksum+ field
+      # Compute checksum and set +checksum+ attribute.
       # @return [Integer]
       def calc_checksum
         sum = IP.sum16(self)

data/lib/packetgen/header/http/headers.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.
@@ -9,14 +9,15 @@
 module PacketGen
   module Header
     # @since 2.2.0
+    # @author Kent 'picat' Gruber
     module HTTP
       # @abstract Base class for HTTP headers.
       # @author Kent 'picat' Gruber
       class Headers
         include BinStruct::Structable
 
-        # Underlying Headers data (or nil).
-        # @return [Hash, nil]
+        # Underlying Headers data.
+        # @return [Hash{String => String}, nil]
         attr_reader :data
         alias to_h data
 
@@ -25,7 +26,7 @@ module PacketGen
         end
 
         # Populate object from a string or directly from a hash.
-        # @param [String, Hash] s_or_h
+        # @param [String, Hash{String=>String}] s_or_h
         # @return [self]
         def read(s_or_h)
           case s_or_h
@@ -69,14 +70,14 @@ module PacketGen
           d.join("\r\n") << "\r\n\r\n"
         end
 
-        # Get a human readable string.
+        # Get a human readable hash.
         # @return [Hash]
         def to_human
           @data
         end
 
         # Read human-readable data to populate header data.
-        # @param [Hash] data
+        # @param [Hash{String=>String}] data
         # @return [self]
         def from_human(data)
           read(data)

data/lib/packetgen/header/http/request.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,28 +10,30 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Request packet consists of:
-      # * the http verb ({BinStruct::String}).
-      # * the path ({BinStruct::String}).
-      # * the version ({BinStruct::String}).
+      # * the http verb (+BinStruct::String+).
+      # * the path (+BinStruct::String+).
+      # * the version (+BinStruct::String+).
       # * associated http headers ({HTTP::Headers}).
+      # * and a {#body} (+BinStruct::String+).
       #
-      # == Create a HTTP Request header
+      # Note: When creating a HTTP Request packet, {TCP#sport} and {TCP#dport}
+      # attributes are not set.
+      #
+      # @example Create a HTTP Request header
       #   # standalone
-      #   http_rqst = PacketGen::Header::HTTP::Request.new
+      #   http_request = PacketGen::Header::HTTP::Request.new
       #   # in a packet
       #   pkt = PacketGen.gen("IP").add("TCP").add("HTTP::Request")
       #   # access to HTTP Request header
-      #   pkt.http_request # => PacketGen::Header::HTTP::Request
-      #
-      # Note: When creating a HTTP Request packet, +sport+ and +dport+
-      # attributes of TCP header are not set.
+      #   pkt.http_request.class # => PacketGen::Header::HTTP::Request
       #
-      # == HTTP Request attributes
-      #   http_rqst.version = "HTTP/1.1"
-      #   http_rqst.verb  = "GET"
-      #   http_rqst.path    = "/meow.html"
-      #   http_rqst.headers = "Host: tcpdump.org"     # string or
-      #   http_rqst.headers = { "Host": "tcpdump.org" } # even a hash
+      # @example HTTP Request attributes
+      #   http_request = PacketGen::Header::HTTP::Request.new
+      #   http_request.version #=> "HTTP/1.1"
+      #   http_request.verb  = "GET"
+      #   http_request.path    = "/meow.html"
+      #   http_request.headers = "Host: tcpdump.org"     # string or
+      #   http_request.headers = { "Host": "tcpdump.org" } # even a hash
       #
       # @author Kent 'picat' Gruber
       # @author Sylvain Daubert
@@ -39,13 +41,16 @@ module PacketGen
       # @since 3.1.0 Rename +#method+ into {#verb} to not mask +Object#method+.
       class Request < Base
         # @!attribute verb
+        #   HTTP verb (method)
         #   @return [BinStruct::String]
         #   @since 3.1.0
         define_attr :verb, BinStruct::String
         # @!attribute path
+        #   Requested path
         #   @return [BinStruct::String]
         define_attr :path,    BinStruct::String
         # @!attribute version
+        #   HTTP version
         #   @return [BinStruct::String]
         define_attr :version, BinStruct::String, default: 'HTTP/1.1'
         # @!attribute headers
@@ -53,6 +58,7 @@ module PacketGen
         #   @return [HTTP::Headers]
         define_attr :headers, HTTP::Headers
         # @!attribute body
+        #   HTTP request body, if any
         #   @return [BinStruct::String]
         define_attr :body, BinStruct::String
 
@@ -67,7 +73,7 @@ module PacketGen
         end
 
         # Read in the HTTP portion of the packet, and parse it.
-        # @return [PacketGen::HTTP::Request]
+        # @return [self]
         def read(str)
           lines = lines(str)
           first_line_words = lines.shift.split
@@ -83,6 +89,8 @@ module PacketGen
           self
         end
 
+        # May be parsed as a HTTP request if verb is known, and if version is +HTTP/1.x+.
+        # @return [Boolean]
         def parse?
           VERBS.include?(self.verb) && self.version.start_with?('HTTP/1.')
         end

data/lib/packetgen/header/http/response.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,25 +10,26 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Response packet consists of:
-      # * the version ({BinStruct::String}).
-      # * the status code ({BinStruct::String}).
-      # * the status message ({BinStruct::String}).
-      # * associated http headers ({HTTP::Headers}).
-      # * the actual http payload body ({BinStruct::String}).
+      # * the version (+BinStruct::String+).
+      # * the status code (+BinStruct::String+).
+      # * the status message (+BinStruct::String+).
+      # * associated HTTP headers ({HTTP::Headers}).
+      # * the actual HTTP payload body (+BinStruct::String+).
       #
-      # == Create a HTTP Response header
+      # Note: When creating a HTTP Response packet, +sport+ and +dport+
+      # attributes of TCP header are not set.
+      #
+      # @example Create a HTTP Response header
       #   # standalone
       #   http_resp = PacketGen::Header::HTTP::Response.new
       #   # in a packet
       #   pkt = PacketGen.gen("IP").add("TCP").add("HTTP::Response")
       #   # access to HTTP Response header
-      #   pkt.http_response # => PacketGen::Header::HTTP::Response
+      #   pkt.http_response.class # => PacketGen::Header::HTTP::Response
       #
-      # Note: When creating a HTTP Response packet, +sport+ and +dport+
-      # attributes of TCP header are not set.
-      #
-      # == HTTP Response attributes
-      #   http_resp.version     = "HTTP/1.1"
+      # @example HTTP Response attributes
+      #   http_resp = PacketGen::Header::HTTP::Response.new
+      #   http_resp.version     #=> "HTTP/1.1"
       #   http_resp.status_code = "200"
       #   http_resp.status_mesg = "OK"
       #   http_resp.body        = "this is a body"
@@ -39,20 +40,24 @@ module PacketGen
       # @author LemonTree55
       class Response < Base
         # @!attribute version
+        #   HTTP version
         #   @return [BinStruct::String]
         define_attr :version,     BinStruct::String, default: 'HTTP/1.1'
         # @!attribute status_code
+        #   Response status code
         #   @return [BinStruct::String]
         define_attr :status_code, BinStruct::String
         # @!attribute status_mesg
+        #   Response status message
         #   @return [BinStruct::String]
         define_attr :status_mesg, BinStruct::String
         # @!attribute headers
         #   associated http/1.1 headers
-        #   @return [BinStruct::String]
+        #   @return [HTTP::Headers]
         define_attr :headers, HTTP::Headers
         # @!attribute body
-        #   @return [HTTP::PHeaders]
+        #   Response body
+        #   @return [BinStruct::String]
         define_attr :body, BinStruct::String
 
         # @param [Hash] options
@@ -67,7 +72,7 @@ module PacketGen
         end
 
         # Read in the HTTP portion of the packet, and parse it.
-        # @return [PacketGen::HTTP::Response]
+        # @return [self]
         def read(str)
           headers, data = collect_headers_and_data(str)
 
@@ -80,6 +85,8 @@ module PacketGen
           self
         end
 
+        # May be parsed as a HTTP response if version is +HTTP/1.x+.
+        # @return [Boolean]
         def parse?
           version.start_with?('HTTP/1.')
         end

data/lib/packetgen/header/http/verbs.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/http.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/icmp.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,24 +15,25 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMP header consists of:
-    # * a {#type} field ({BinStruct::Int8} type),
-    # * a {#code} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
+    # * a {#type} field (+BinStruct::Int8+ type),
+    # * a {#code} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * and a {#body}.
     #
-    # == Create a ICMP header
+    # @example Create a ICMP header
     #  # standalone
     #  icmp = PacketGen::Header::ICMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('ICMP')
     #  # access to ICMP header
-    #  pkt.icmp     # => PacketGen::Header::ICMP
+    #  pkt.icmp.class   # => PacketGen::Header::ICMP
     #
-    # == ICMP attributes
+    # @example ICMP attributes
+    #  icmp = PacketGen::Header::ICMP.new
     #  icmp.code = 0
     #  icmp.type = 200
     #  icmp.checksum = 0x248a
-    #  icmp.body.read 'this is a body'
+    #  icmp.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMP < Base
       # ICMP internet protocol number
@@ -51,7 +52,8 @@ module PacketGen
       #  @return [Integer]
       define_attr :checksum, BinStruct::Int16
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      # ICMP body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       # Compute checksum and set +checksum+ field
@@ -61,9 +63,7 @@ module PacketGen
         self.checksum = IP.reduce_checksum(sum)
       end
     end
-
     self.add_class ICMP
-
     IP.bind ICMP, protocol: ICMP::IP_PROTOCOL
   end
 end