packetgen 4.0.0 → 4.1.1

data/lib/packetgen/header/dot11/management.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.
@@ -16,28 +16,31 @@ module PacketGen
       # (management frame).
       #
       # A IEEE 802.11 management header consists of:
-      # * a {#frame_ctrl} ({BinStruct::Int16}),
-      # * a {#id}/duration ({BinStruct::Int16le}),
+      # * a {#frame_ctrl} (+BinStruct::Int16+),
+      # * a {#id}/duration (+BinStruct::Int16le+),
       # * a {#mac1} ({Eth::MacAddr}).
       # * a {#mac2} ({Eth::MacAddr}),
       # * a {#mac3} ({Eth::MacAddr}),
-      # * a {#sequence_ctrl} ({BinStruct::Int16}),
-      # * a {#body} (a {BinStruct::String} or another {Base} class),
-      # * and a Frame check sequence ({#fcs}, of type {BinStruct::Int32le}).
+      # * a {#sequence_ctrl} (+BinStruct::Int16+),
+      # * a {#body} (a +BinStruct::String+ or another {Headerable} class),
+      # * and a Frame check sequence ({#fcs}, of type +BinStruct::Int32le+).
       #
       # Management frames should be constructed with more headers from
-      # {SubMngt} subclasses.
+      # {SubMngt} subclasses. Some frames also need to have {Element}.
       #
-      # By example, build a {DeAuth} frame:
+      # @example Build a {DeAuth} frame:
       #   PacketGen.gen('Dot11::Management').add('Dot11::DeAuth')
       #
-      # Some frames need to have {Element}. By example a {Beacon} frame:
-      #   pkt = PacketGen.gen('Dot11::Management', mac1: broadcast, mac2: bssid, mac3: bssid).
-      #                   add('Dot11::Beacon')
-      #   pkt.dot11_beacon.add_elements(type: 'SSID', value: ssid)
-      #   pkt.dot11_beacon.add_elements(type: 'Rates', value: "\x82\x84\x8b\x96\x12\x24\x48\x6c")
-      #   pkt.dot11_beacon.add_elements(type: 'DSset', value: "\x06")
-      #   pkt.dot11_beacon.add_elements(type: 'TIM', value: "\x00\x01\x00\x00")
+      # @example a {Beacon} frame with elements:
+      #   bssid = '00:01:02:03:04:05'
+      #   pkt = PacketGen.gen('Dot11::Management', mac1: 'ff:ff:ff:ff:ff:ff', mac2: bssid, mac3: bssid)
+      #                  .add('Dot11::Beacon')
+      #   # Directly add elements to Beacon
+      #   pkt.dot11_beacon.elements << { type: 'SSID', value: "SSIDSSID" }
+      #   pkt.dot11_beacon.elements << { type: 'Rates', value: "\x82\x84\x8b\x96\x12\x24\x48\x6c" }
+      #   # Add elements to beacon through management header
+      #   pkt.dot11_management.add_element(type: 'DSset', value: "\x06")
+      #   pkt.dot11_management.add_element(type: 'TIM', value: "\x00\x01\x00\x00")
       # @author Sylvain Daubert
       class Management < Dot11
         # @param [Hash] options
@@ -48,7 +51,7 @@ module PacketGen
           define_applicable_attributes
         end
 
-        # Add an {Element}
+        # Add an {Element} to header in body (for example, a {Dot11::Beacon})
         # @param [Integer,String] type element type
         # @param [Object] value element value
         # @return [self]

data/lib/packetgen/header/dot11/sub_mngt.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.
@@ -19,6 +19,7 @@ module PacketGen
       # may be accessed through {#elements}.
       # @author Sylvain Daubert
       class SubMngt < Base
+        # Elements of submngt header
         # @return [Array<Element>]
         define_attr :elements, ArrayOfElements
       end
@@ -28,8 +29,8 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 0.
       #
       # Add fields:
-      # * {#cap} ({BinStruct::Int16le}),
-      # * {#listen_interval} ({BinStruct::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#listen_interval} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class AssoReq < SubMngt
         # @!attribute cap
@@ -47,9 +48,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 1.
       #
       # Add fields:
-      # * {#cap} ({BinStruct::Int16le}),
-      # * {#status} ({BinStruct::Int16le}),
-      # * {#aid} ({BinStruct::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+),
+      # * {#aid} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class AssoResp < SubMngt
         # @!attribute cap
@@ -70,8 +71,8 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 2.
       #
       # Add fields:
-      # * {#cap} ({BinStruct::Int16le}),
-      # * {#listen_interval} ({BinStruct::Int16le}),
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#listen_interval} (+BinStruct::Int16le+),
       # * {#current_ap} ({Eth::MacAddr}).
       # @author Sylvain Daubert
       class ReAssoReq < AssoReq
@@ -87,9 +88,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 3.
       #
       # Add fields:
-      # * {#cap} ({BinStruct::Int16le}),
-      # * {#status} ({BinStruct::Int16le}),
-      # * {#aid} ({BinStruct::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+),
+      # * {#aid} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class ReAssoResp < AssoResp
       end
@@ -112,9 +113,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 5.
       #
       # Add fields:
-      # * {#timestamp} ({BinStruct::Int64le}),
-      # * {#beacon_interval} ({BinStruct::Int16le}),
-      # * {#cap} ({BinStruct::Int16le}).
+      # * {#timestamp} (+BinStruct::Int64le+),
+      # * {#beacon_interval} (+BinStruct::Int16le+),
+      # * {#cap} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class ProbeResp < SubMngt
         # @!attribute timestamp
@@ -135,9 +136,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 8.
       #
       # Add fields:
-      # * {#timestamp} ({BinStruct::Int64le}),
-      # * {#interval} ({BinStruct::Int16le}),
-      # * {#cap} ({BinStruct::Int16le}).
+      # * {#timestamp} (+BinStruct::Int64le+),
+      # * {#interval} (+BinStruct::Int16le+),
+      # * {#cap} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Beacon < SubMngt
         # @!attribute timestamp
@@ -168,7 +169,7 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 10.
       #
       # Add fields:
-      # * {#reason} ({BinStruct::Int16le}).
+      # * {#reason} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Disas < SubMngt
         # @!attribute reason
@@ -183,9 +184,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 11.
       #
       # Add fields:
-      # * {#algo} ({BinStruct::Int16le}),
-      # * {#seqnum} ({BinStruct::Int16le}),
-      # * {#status} ({BinStruct::Int16le}).
+      # * {#algo} (+BinStruct::Int16le+),
+      # * {#seqnum} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Auth < SubMngt
         # @!attribute algo
@@ -206,7 +207,7 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 12.
       #
       # Add fields:
-      # * {#reason} ({BinStruct::Int16le}).
+      # * {#reason} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class DeAuth < SubMngt
         # @!attribute reason

data/lib/packetgen/header/dot11.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.
@@ -103,58 +103,54 @@ module PacketGen
     end
     self.add_class RadioTap
 
-    # IEEE 802.11 header
     # @abstract This is a base class to demultiplex different IEEE 802.11 frames when
     #   parsing.
     # A IEEE 802.11 header may consist of at least:
-    # * a {#frame_ctrl} ({BinStruct::Int16}),
-    # * a {#id}/duration ({BinStruct::Int16le}),
+    # * a {#frame_ctrl} (+BinStruct::Int16+),
+    # * a {#id}/duration (+BinStruct::Int16le+),
     # * and a {#mac1} ({Eth::MacAddr}).
     # Depending on frame type and subtype, it may also contains:
     # * a {#mac2} ({Eth::MacAddr}),
     # * a {#mac3} ({Eth::MacAddr}),
-    # * a {#sequence_ctrl} ({BinStruct::Int16}),
+    # * a {#sequence_ctrl} (+BinStruct::Int16+),
     # * a {#mac4} ({Eth::MacAddr}),
-    # * a {#qos_ctrl} ({BinStruct::Int16}),
-    # * a {#ht_ctrl} ({BinStruct::Int32}),
-    # * a {#body} (a {BinStruct::String} or another {Base} class),
-    # * a Frame check sequence ({#fcs}, of type {BinStruct::Int32le})
+    # * a {#qos_ctrl} (+BinStruct::Int16+),
+    # * a {#ht_ctrl} (+BinStruct::Int32+),
+    # * a {#body} (a +BinStruct::String+ or another {Headerable} class),
+    # * a Frame check sequence ({#fcs}, of type +BinStruct::Int32le+)
     #
     # == Header accessors
     # As Dot11 header types are defined under Dot11 namespace, Dot11 header accessors
-    # have a specific name. By example, to access to a {Dot11::Beacon} header,
+    # have a specific name. For example, to access to a {Dot11::Beacon} header,
     # accessor is +#dot11_beacon+.
     #
     # == Create Dot11 packets
     # As {Dot11} is an abstract class, you have to use one of its subclasses to
-    # instanciate a IEEE802.11 header.
+    # instanciate a IEEE802.11 header (see examples below).
     #
-    # === IEEE802.11 control frames
-    # Control frames may be created this way:
+    # @example Create IEEE802.11 control frames
     #   pkt = PacketGen.gen('Dot11::Control', subtype: 13) # Ack control frame
-    #   pkt.dot11_control     # => PacketGen::Header::Dot11::Control
+    #   pkt.dot11_control.class   # => PacketGen::Header::Dot11::Control
     #   # #dot11 is a shortcut for #dot11_control
-    #   pkt.dot11             # => PacketGen::Header::Dot11::Control
+    #   pkt.dot11.class           # => PacketGen::Header::Dot11::Control
     #
-    # === IEEE802.11 management frames
-    # Management frames may be created this way:
+    # @example Create IEEE802.11 management frames
     #   pkt = PacketGen.gen('Dot11::Management')
-    #   pkt.dot11_management     # => PacketGen::Header::Dot11::Management
+    #   pkt.dot11_management.class   # => PacketGen::Header::Dot11::Management
     #   # #dot11 is a shortcut for #dot11_management
-    #   pkt.dot11                # => PacketGen::Header::Dot11::Management
-    # Management frames are usually specialized, AssociationRequest by example:
+    #   pkt.dot11.class              # => PacketGen::Header::Dot11::Management
+    #   # Management frames are usually specialized, AssociationRequest by example
     #   pkt.add('Dot11::AssoReq')
-    #   pkt.dot11_assoreq        # => PacketGen::Header::Dot11::AssoReq
-    # Management frames also may contain some elements (see IEEE 802.11 standard):
-    #   pkt.dot11_assoreq.add_elements(type: 'SSID', value: "My SSID")
-    #   pkt.dot11_assoreq.add_elements(type: 'Rates', value: supported_rates)
+    #   pkt.dot11_assoreq .class     # => PacketGen::Header::Dot11::AssoReq
+    #   # Management frames also may contain some elements (see IEEE 802.11 standard)
+    #   pkt.dot11_assoreq.elements << { type: 'SSID', value: "My SSID" }
+    #   pkt.dot11_assoreq.elements << { type: 'Rates', value: "\x8c\x12\x98\x24\xb0" }
     #
-    # === IEEE802.11 data frames
-    # Data frames may be created this way:
+    # @example Create IEEE802.11 data frames
     #   pkt = PacketGen.gen('Dot11::Data')
-    #   pkt.dot11_data     # => PacketGen::Header::Dot11::Data
+    #   pkt.dot11_data.class   # => PacketGen::Header::Dot11::Data
     #   # #dot11 is a shortcut for #dot11_data
-    #   pkt.dot11          # => PacketGen::Header::Dot11::Data
+    #   pkt.dot11.class        # => PacketGen::Header::Dot11::Data
     #
     # == Parse Dot11 packets
     # When parsing a Dot11 packet, Dot11 subclass is created from +type+ value.
@@ -163,13 +159,12 @@ module PacketGen
     # for a control frame, +Packet#dot11_control+ may also be used.
     #
     # == Send Dot11 packets
-    # To send a Dot11 packet, a RadioTap header is needed:
+    # To send a Dot11 packet, a RadioTap or PPI header is needed (depending on your hardware):
     #   pkt = PacketGen.gen('RadioTap')
     #   pkt.add('Dot11::Management', mac1: client, mac2: bssid, mac3: bssid)
     #   pkt.add('Dot11::Beacon')
-    #   pkt.dot11_beacon.add_element(type: 'SSID', value: 'My SSID')
-    #   pkt.dot11_beacon.add_element(type: 'Rates', value: "\x85\x0c")
-    #   pkt.calc
+    #   pkt.dot11_management.add_element(type: 'SSID', value: 'My SSID')
+    #   pkt.dot11_management.add_element(type: 'Rates', value: "\x85\x0c")
     #   pkt.to_w('wlan0')
     # @author Sylvain Daubert
     # @since 1.4.0
@@ -226,10 +221,12 @@ module PacketGen
       define_attr :mac3, Eth::MacAddr
       # @!attribute sequence_ctrl
       #  @return [Integer] 16-bit sequence control word
-      # @!attribute sequence_number (12-bit field from {#sequence_ctrl})
+      # @!attribute sequence_number
+      #  12-bit field from {#sequence_ctrl}
       #  @return [Integer]
       #  @since 2.1.3
-      # @!attribute fragment_number (4-bit field from {#sequence_ctrl})
+      # @!attribute fragment_number
+      #  4-bit attribute from {#sequence_ctrl}
       #  @return [Integer]
       #  @since 2.1.3
       define_bit_attr :sequence_ctrl, sequence_number: 12, fragment_number: 4
@@ -243,9 +240,11 @@ module PacketGen
       #  @return [Integer] 16-bit HT control word
       define_attr :ht_ctrl, BinStruct::Int32
       # @!attribute body
+      #  Dot11 body, if any
       #  @return [BinStruct::String]
       define_attr :body, BinStruct::String
       # @!attribute fcs
+      #  Checksum of the Dot11 frame.
       #  @return [BinStruct::Int32le]
       define_attr :fcs, BinStruct::Int32le
 
@@ -260,7 +259,7 @@ module PacketGen
         @applicable_attributes = old_attributes
       end
 
-      # Get all used field names
+      # Get all used attribute names
       # @return [Array<Symbol>]
       def attributes
         @applicable_attributes
@@ -279,7 +278,7 @@ module PacketGen
         if self.instance_of?(Dot11)
           return self if str.nil?
 
-          force_binary str
+          str = str.b unless str.encoding == Encoding::BINARY
           self[:frame_ctrl].read(str[0, 2])
 
           case type
@@ -305,10 +304,11 @@ module PacketGen
         fcs
       end
 
+      # Generate binary string
       # @return [String]
       def to_s
         define_applicable_attributes
-        @applicable_attributes.map { |f| force_binary @attributes[f].to_s }.join
+        @applicable_attributes.map { |f| @attributes[f].to_s.b }.join
       end
 
       # Get human readable type
@@ -343,7 +343,7 @@ module PacketGen
         Inject.inject(iface: iface, data: self)
       end
 
-      # Callback called when a Dot11 header is added to a packet
+      # Callback called when a Dot11 header is added to a packet.
       # Here, add +#dot11+ method as a shortcut to existing
       # +#dot11_(control|management|data)+.
       # @param [Packet] packet
@@ -357,7 +357,7 @@ module PacketGen
       private
 
       def remove_from_applicable_attributes(attributes)
-        attributes = [attributes] unless attributes.is_a? Array
+        attributes = [attributes] unless attributes.is_a?(Array)
         @applicable_attributes -= attributes
       end
 

data/lib/packetgen/header/dot1q.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,13 +11,14 @@ module PacketGen
     # IEEE 802.1Q VLAN tagging
     #
     # A VLAN tag consists of:
-    # * a {#tci Tag Control Information} ({BinStruct::Int16}),
-    # * a {#ethertype} ({BinStruct::Int16}),
-    # * and a body (a {BinStruct::String} or another Header class).
+    # * a {#tci Tag Control Information} (+BinStruct::Int16+),
+    # * a {#ethertype} (+BinStruct::Int16+),
+    # * and a body (a +BinStruct::String+ or another {Headerable} class).
     #
-    # == Create a Dot1q header
+    # @example Create a Dot1q header
     #   # Create a IP packet in VLAN #43
     #   pkt = PacketGen.gen('Eth').add('Dot1q', vid: 43).add('IP')
+    #   pkt.is?('Dot1q')   #=> true
     # @author Sylvain Daubert
     # @since 1.4.0
     class Dot1q < Base

data/lib/packetgen/header/dot1x.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,15 +11,15 @@ module PacketGen
     # IEEE 802.1X / EAPOL
     #
     # A IEEE 802.1X header consists of:
-    # * a {#version} ({BinStruct::Int8}),
-    # * a packet {#type} ({BinStruct::Int8}),
-    # * a {#length} ({BinStruct::Int16}),
-    # * and a body (a {BinStruct::String} or another Header class).
-    # == Create a Dot1x header
+    # * a {#version} (+BinStruct::Int8+),
+    # * a packet {#type} (+BinStruct::Int8+),
+    # * a {#length} (+BinStruct::Int16+),
+    # * and a body (a +BinStruct::String+ or another {Headerable} class).
+    # @example Create a Dot1x header
+    #   # Create with integer type
     #   pkt1 = PacketGen.gen('Eth').add('Dot1x', type: 1)
-    #   pkt2 = PacketGen.gen('Eth').add('Dot1x')
-    #   pkt2.dot1x.type = 'EAP Packet'
-    #   pkt2.dot1x.body.read 'body'
+    #   # Create with human-readable type
+    #   pkt2 = PacketGen.gen('Eth').add('Dot1x', type: 'EAP Packet')
     # @author Sylvain Daubert
     # @since 1.4.0
     class Dot1x < Base

data/lib/packetgen/header/eap/fast.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.
@@ -13,9 +13,9 @@ module PacketGen
       # Secure Tunneling, {https://tools.ietf.org/html/rfc4851 RFC 4851}
       #
       # {EAP::FAST} has following fields:
-      # * {#flags} ({BinStruct::Int8}),
-      # * optionally {#message_length} ({BinStruct::Int32}), if +#l?+ is +true+,
-      # * {#body} ({BinStruct::String}).
+      # * {#flags} (+BinStruct::Int8+),
+      # * optionally {#message_length} (+BinStruct::Int32+), if +#l?+ is +true+,
+      # * {#body} (+BinStruct::String+).
       # @author Sylvain Daubert
       # @since 2.1.4
       class FAST < TTLS

data/lib/packetgen/header/eap/md5.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,15 +18,23 @@ module PacketGen
         remove_attr :body
 
         # @!attribute value_size
-        #  @return [Integer] 8-bit value size
+        #  8-bit size of the {#value} attribute.
+        #  @return [Integer]
         define_attr :value_size, BinStruct::Int8
         # @!attribute value
+        #  MD5 challenge value, as an octet stream, as per {https://datatracker.ietf.org/doc/html/rfc1994#section-4 RFC1994}
         #  @return [::String]
         define_attr :value, BinStruct::String,
                     builder: ->(h, t) { t.new(length_from: h[:value_size]) }
-        # @!attribute optional_name
+        # @!attribute name
+        #  Name identifying the system sending the packet. It is or or more octets. Its size is
+        #  determined from the {#length} attribute.
         #  @return [::String]
-        define_attr :optional_name, BinStruct::String
+        # @since 4.1.0 Attribute renamed from +optioanl_name+ to +name+
+        define_attr :name, BinStruct::String
+
+        # @deprecated
+        alias optional_name name
       end
     end
   end

data/lib/packetgen/header/eap/tls.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.
@@ -13,22 +13,23 @@ module PacketGen
       # {https://tools.ietf.org/html/rfc5216 RFC 5216}
       #
       # {EAP::TLS} has following fields:
-      # * {#flags} ({BinStruct::Int8}),
-      # * optionally {#tls_length} ({BinStruct::Int32}), if +#l?+ is +true+,
-      # * {#body} ({BinStruct::String}).
+      # * {#flags} (+BinStruct::Int8+),
+      # * optionally {#tls_length} (+BinStruct::Int32+), if +#l?+ is +true+,
+      # * {#body} (+BinStruct::String+).
       # @author Sylvain Daubert
       # @since 2.1.4
       class TLS < EAP
         update_attr :type, default: 13
         # @!attribute flags
-        #  @return [Integer] 8-bit flags
-        # @!attribute l
-        #  Say if length field is included
+        #  8-bit flags
         #  @return [Integer]
-        # @!attribute m
+        # @!attribute l?
+        #  Say if {#tls_length 32-bit TLS length attribute} is included.
+        #  @return [Integer]
+        # @!attribute m?
         #  Say if there are more fragments
         #  @return [Integer]
-        # @!attribute s
+        # @!attribute s?
         #  If set, this message is a TLS-Start
         #  @return [Integer]
         define_bit_attr_before :body, :flags, l: 1, m: 1, s: 1, reserved: 5

data/lib/packetgen/header/eap/ttls.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.
@@ -13,28 +13,31 @@ module PacketGen
       # {https://tools.ietf.org/html/rfc5281 RFC 5281}
       #
       # {EAP::TTLS} has following fields:
-      # * {#flags} ({BinStruct::Int8}),
-      # * optionally {#message_length} ({BinStruct::Int32}), if +#l?+ is +true+,
-      # * {#body} ({BinStruct::String}).
+      # * {#flags} (+BinStruct::Int8+),
+      # * optionally {#message_length} (+BinStruct::Int32+), if +#l?+ is +true+,
+      # * {#body} (+BinStruct::String+).
       # @author Sylvain Daubert
       # @since 2.1.4
       class TTLS < EAP
         update_attr :type, default: 21
         # @!attribute flags
-        #  @return [Integer] 8-bit flags
-        # @!attribute l
-        #  Say if length field is included
+        #  8-bit flags
         #  @return [Integer]
-        # @!attribute m
+        # @!attribute l?
+        #  Say if {#message_length} field is included
+        #  @return [Integer]
+        # @!attribute m?
         #  Say if there are more fragments
         #  @return [Integer]
-        # @!attribute s
+        # @!attribute s?
         #  If set, this message is a TLS-Start
         #  @return [Integer]
         # @!attribute reserved
-        #  @return [Integer] 2-bit reserved integer
+        #   2-bit reserved integer
+        #  @return [Integer]
         # @!attribute version
-        #  @return [Integer] 3-bit version
+        #  3-bit version
+        #  @return [Integer]
         define_bit_attr_before :body, :flags, l: 1, m: 1, s: 1, reserved: 2, version: 3
         alias length_present? l?
         alias more_fragments? m?