packetgen 4.0.0 → 4.1.0

data/lib/packetgen/header/dot11.rb

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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?

data/lib/packetgen/header/eap.rb

@@ -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

@@ -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

@@ -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)