packetgen 4.0.0 → 4.1.0

data/lib/packetgen/header/sctp/parameter.rb

@@ -9,30 +9,18 @@
 module PacketGen
   module Header
     class SCTP
-      # Common methods to Init and InitAck parameters
-      # @author Sylvain Daubert
-      module ParameterMixin
-        include Padded32
-
-        # Get parameter name
-        # @return [String]
-        def parameter_name
-          self.class.name.split('::').last.delete_suffix('Parameter')
-        end
-
-        # @return [String]
-        def to_human
-          "<#{parameter_name}: #{value}>"
-        end
-      end
-
+      # @!parse
+      #   class Parameter < BinStruct::AbstractTLV; end
       Parameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
                                                 length_class: BinStruct::Int16,
                                                 attr_in_length: 'TLV')
       # Base class/factory for {InitChunk} and {InitAckChunk} parameters
       # @author Sylvain Daubert
+      # @author LemonTree55
+      # @since 3.4.0
+      # @since 4.1.0 No more include +ParamterMixin+.
       class Parameter
-        include ParameterMixin
+        include Padded32
 
         # Paramter Types
         TYPES = {
@@ -46,12 +34,19 @@ module PacketGen
           'ECN' => 32_768
         }.freeze
 
+        # Get human-readable descriptiob
         # @return [::String]
         def to_human
-          "<#{human_type}: #{self[:value].inspect}>"
+          value = if self[:value].is_a?(BinStruct::String)
+                    self[:value].inspect
+                  else
+                    self[:value].to_human
+                  end
+          "<#{human_type}: #{value}>"
         end
 
-        # @param [Object] value
+        # Populate parameter from a human-readable string or a Parameter.
+        # @param [Parameter,String] value
         def from_human(value)
           if value.is_a?(self[:value].class)
             self[:value] = value
@@ -59,94 +54,77 @@ module PacketGen
             self[:value].from_human(value)
           end
         end
+
+        # Get parameter name
+        # @return [String]
+        def parameter_name
+          self.class.name.split('::').last.delete_suffix('Parameter')
+        end
       end
       Parameter.define_type_enum(Parameter::TYPES)
 
-      IPv4Parameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                    length_class: BinStruct::Int16,
-                                                    value_class: IP::Addr,
-                                                    attr_in_length: 'TLV')
-
-      # IPv4 address parameter
-      # @author Sylvain Daubert
-      class IPv4Parameter
-        include ParameterMixin
-      end
-      IPv4Parameter.define_type_enum(Parameter::TYPES)
+      # @!parse
+      #   # IPv4 address parameter. A {Parameter} whose value is a {IP::Addr}.
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class IPv4Parameter < Parameter; end
+      IPv4Parameter = Parameter.derive(value_class: IP::Addr)
       IPv4Parameter.define_type_default('IPv4')
 
-      IPv6Parameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                    length_class: BinStruct::Int16,
-                                                    value_class: IPv6::Addr,
-                                                    attr_in_length: 'TLV')
-
-      # IPv6 address parameter
-      # @author Sylvain Daubert
-      class IPv6Parameter
-        include ParameterMixin
-      end
-      IPv6Parameter.define_type_enum(Parameter::TYPES)
+      # @!parse
+      #   # IPv6 address parameter. A {Parameter} whose value is a {IPv6::Addr}.
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class IPv6Parameter < Parameter; end
+      IPv6Parameter = Parameter.derive(value_class: IPv6::Addr)
       IPv6Parameter.define_type_default('IPv6')
 
-      StateCookieParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                           length_class: BinStruct::Int16,
-                                                           value_class: BinStruct::String,
-                                                           attr_in_length: 'TLV')
-
-      # State Cookie parameter
+      # State Cookie parameter. A {Parameter} whose value is a cookie string.
       # @author Sylvain Daubert
-      class StateCookieParameter
-        include ParameterMixin
-
-        # @return [::String]
-        def to_human
-          "<#{parameter_name}: #{self[:value].inspect}>"
-        end
+      # @author LemonTree55
+      # @since 3.4.0
+      # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      class StateCookieParameter < Parameter
       end
-      StateCookieParameter.define_type_enum(Parameter::TYPES)
       StateCookieParameter.define_type_default('StateCookie')
 
-      UnrecognizedParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                            length_class: BinStruct::Int16,
-                                                            value_class: Parameter,
-                                                            attr_in_length: 'TLV')
-
-      # Unrecognized parameter
-      # @author Sylvain Daubert
-      class UnrecognizedParameter
-        include ParameterMixin
-
-        # @return [::String]
-        def to_human
-          "<#{parameter_name}: #{self[:value].to_human}"
-        end
-      end
-      UnrecognizedParameter.define_type_enum(Parameter::TYPES)
+      # @!parse
+      #   # Unrecognized parameter. A {Parameter} whose value is a {Parameter}.
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class UnrecognizedParameter < Parameter; end
+      UnrecognizedParameter = Parameter.derive(value_class: Parameter)
       UnrecognizedParameter.define_type_default('Unrecognized')
 
-      HostnameParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                        length_class: BinStruct::Int16,
-                                                        value_class: BinStruct::CString,
-                                                        attr_in_length: 'TLV')
-
-      # Hostname address parameter
-      # @author Sylvain Daubert
-      class HostnameParameter
-        include ParameterMixin
-      end
-      HostnameParameter.define_type_enum(Parameter::TYPES)
+      # @!parse
+      #   # Hostname address parameter. A {Parameter} whose value is a null-terminated string.
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class HostnameParameter < Parameter; end
+      HostnameParameter = Parameter.derive(value_class: BinStruct::CString)
       HostnameParameter.define_type_default('Hostname')
 
-      SupportedAddrTypesParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                                  length_class: BinStruct::Int16,
-                                                                  value_class: BinStruct::ArrayOfInt16,
-                                                                  attr_in_length: 'TLV')
+      # @!parse
+      #   # Supported address types parameter. æ {Parameter} whose value is an array of supported address types
+      #   # (as +BinStruct::Int16+).
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class SupportedAddrTypesParameter < Parameter; end
+      SupportedAddrTypesParameter = Parameter.derive(value_class: BinStruct::ArrayOfInt16)
+      SupportedAddrTypesParameter.define_type_default('SupportedAddrTypes')
 
-      # Supported address types parameter
-      # @author Sylvain Daubert
       class SupportedAddrTypesParameter
-        include ParameterMixin
-
+        # Get human-readable description
         # @return [::String]
         def to_human
           types = self[:value].map(&:to_i).map do |int16|
@@ -155,57 +133,32 @@ module PacketGen
           "<#{parameter_name}: #{types}>"
         end
       end
-      SupportedAddrTypesParameter.define_type_enum(Parameter::TYPES)
-      SupportedAddrTypesParameter.define_type_default('SupportedAddrTypes')
-
-      CookiePreservativeParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                                  length_class: BinStruct::Int16,
-                                                                  value_class: BinStruct::Int32,
-                                                                  attr_in_length: 'TLV')
-
-      # Cookie Preservative parameter
-      # @author Sylvain Daubert
-      class CookiePreservativeParameter
-        include ParameterMixin
 
-        # @return [::String]
-        def to_human
-          "<#{parameter_name}: #{value}>"
-        end
-      end
-      CookiePreservativeParameter.define_type_enum(Parameter::TYPES)
+      # @!parse
+      #   # Cookie preservative parameter. A {Parameter} whose value is a +BinStruct::Int32+.
+      #   # @author Sylvain Daubert
+      #   # @author LemonTree55
+      #   # @since 3.4.0
+      #   # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      #   class CookiePreservativeParameter < Parameter; end
+      CookiePreservativeParameter = Parameter.derive(value_class: BinStruct::Int32)
       CookiePreservativeParameter.define_type_default('CookiePreservative')
 
-      ECNParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                   length_class: BinStruct::Int16,
-                                                   attr_in_length: 'TLV')
-
-      # ECN parameter
+      # ECN parameter. A {Parameter} who has no value.
       # @author Sylvain Daubert
-      class ECNParameter
-        include ParameterMixin
-
+      # @author LemonTree55
+      # @since 3.4.0
+      # @since 4.1.0 Subclass of {Parameter}. No more include +ParameterMixin+.
+      class ECNParameter < Parameter
+        # Get human readable description
         # @return [::String]
         def to_human
           "<#{parameter_name}>"
         end
       end
-      ECNParameter.define_type_enum(Parameter::TYPES)
       ECNParameter.define_type_default('ECN')
 
-      HearbeatInfoParameter = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
-                                                            length_class: BinStruct::Int16,
-                                                            attr_in_length: 'TLV')
-
-      # Heartbeat Information parameter
-      # @author Sylvain Daubert
-      class HearbeatInfoParameter
-        include ParameterMixin
-      end
-      HearbeatInfoParameter.define_type_enum({ 'HearbeatInfo' => 1 }.freeze)
-      HearbeatInfoParameter.define_type_default('HearbeatInfo')
-
-      # Array of {Parameter}s and {ParameterMixin}.
+      # Array of {Parameter parameters}.
       # @author Sylvain Daubert
       class ArrayOfParameter < BinStruct::Array
         set_of Parameter
@@ -221,7 +174,7 @@ module PacketGen
         end
 
         def real_klass_name(type_name)
-          type_name + 'Parameter' # rubocop:disable Style/StringConcatenation
+          "#{type_name}Parameter"
         end
       end
     end

data/lib/packetgen/header/sctp.rb

@@ -26,8 +26,17 @@ module PacketGen
     #  |                           Chunk #n                            |
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
+    # A SCTP header is composed of:
+    # * {#sport}, source port number (+BinStruct::Int16+),
+    # * {#dport}, destination port number (+BinStruct::Int16+),
+    # * {#verification_tag} (+BinStruct::Int32+),
+    # * {#checksum} (+BinStruct::Int32le+),
+    # * {#chunks}, list of {BaseChunk chunks} ({ArrayOfChunk}).
+    #
     # @author Sylvain Daubert
+    # @author LemonTree55
     # @since 3.4.0
+    # @since 4.1.0 Remove +ErrorMixin+ and +ParameterMixin+
     class SCTP < Base; end
   end
 end
@@ -56,7 +65,7 @@ module PacketGen
       #  @return [Integer]
       define_attr :verification_tag, BinStruct::Int32
       # @!attribute checksum
-      #  32-bit TCP checksum
+      #  32-bit TCP checksum. This is a CRC32C checkum, computed on SCTP header and all its chunks.
       #  @return [Integer]
       define_attr :checksum, BinStruct::Int32le
       # @!attribute chunks
@@ -64,7 +73,8 @@ module PacketGen
       #  @return [ArrayOfChunk]
       define_attr :chunks, ArrayOfChunk
 
-      # Compute SCTP checksum
+      # Compute SCTP checksum and set {#checksum} attribute.
+      # @return [Integer]
       def calc_checksum
         self.checksum = 0
         crc32c = Digest::CRC32c.new
@@ -72,7 +82,8 @@ module PacketGen
         self.checksum = crc32c.checksum
       end
 
-      # Compute SCTP chunks length
+      # Compute SCTP chunk lengths
+      # @return [void]
       def calc_length
         self.chunks.each(&:calc_length)
       end

data/lib/packetgen/header/snmp.rb

@@ -15,7 +15,44 @@ module PacketGen
     # Simple Network Management Protocol (SNMP)
     #
     # See https://github.com/lemontree55/packetgen/wiki/SNMP
+    #
+    # SNMP is defined from ASN.1:
+    #   Message ::=
+    #     SEQUENCE {
+    #          version
+    #             INTEGER {
+    #                 version-1(0)
+    #             },
+    #          community      -- community name
+    #              OCTET STRING,
+    #          data           -- e.g., PDUs if trivial
+    #              ANY        -- authentication is being used
+    #     }
+    # It has 3 attributes, accessible through +#[]+:
+    # * +:version+, SNMP protocol version (type +RASN1::Types::Integer+ with enumeration),
+    # * +:community+ (type +RASN1::Types::OctetString+),
+    # * +:data+ (type {PDUs}).
+    #
+    # @!attribute version
+    #   version attribute. Shortcut for +snmp[:version].value+.
+    #   String values are: +v1+, +v2+, +v2c+ and +v3+.
+    #   @return [String]
+    # @!attribute community
+    #   community attribute. Shortcut for +snmp[:community].value+.
+    #   @return [String]
+    #
+    # @example
+    #  snmp = PacketGen::Header::SNMP.new(version: "v3",
+    #                                     chosen_pdu: PacketGen::Header::SNMP::PDU_SET,
+    #                                     pdu: { id: 1, varbindlist: [{ name: '1.2.3.4' }] })
+    #  snmp.version        #=> "v3"
+    #  snmp.community      #=> "public"
+    #  snmp.pdu.class      #=> PacketGen::Header::SNMP::SetRequest
+    #  snmp.pdu[:id].value #=> 1
+    #  snmp.pdu[:varbindlist][0][:name].inspect #=> 'name OBJECT ID: "1.2.3.4"'
+    #  snmp.pdu[:varbindlist][0][:name].value   #=> "1.2.3.4"
     # @author Sylvain Daubert
+    # @author LemonTree55
     # @since 2.0.0
     class SNMP < ASN1Base
       # Agents listen to this port
@@ -23,19 +60,26 @@ module PacketGen
       # Configuration sinks listen to this port
       UDP_PORT2 = 162
 
-      # rubocop:disable Naming/ConstantName
-
+      # Implicit tag number for GetRequest PDU type
       PDU_GET      = 0
+      # Implicit tag number for GetNextRequest PDU type
       PDU_NEXT     = 1
+      # Implicit tag number for GetResponse PDU type
       PDU_RESPONSE = 2
+      # Implicit tag number for SetRequest PDU type
       PDU_SET      = 3
+      # Implicit tag number for Trapv1 PDU type
       PDU_TRAPv1   = 4
+      # Implicit tag number for Bulk PDU type
       PDU_BULK     = 5
+      # Implicit tag number for InformRequest PDU type
       PDU_INFORM   = 6
+      # Implicit tag number for Trapv2 PDU type
       PDU_TRAPv2   = 7
+      # Implicit tag number for Report PDU type
       PDU_REPORT   = 8
-      # rubocop:enable Naming/ConstantName
 
+      # Error types
       ERRORS = {
         'no_error' => 0,
         'too_big' => 1,
@@ -63,7 +107,13 @@ module PacketGen
       #                name  OBJECT IDENTIFIER,
       #                value ANY     -- depends on name
       #              }
+      # This class associates a +:name+ (type +RASN1::Types::ObjectId+) to a +:value+ (any RASN1 type).
+      # @example
+      #   vb = PacketGen::Header::SNMP::VarBind.new(name: "1.2.3.4", value: RASN1::Types::OctetString.new(value: "abc"))
+      #   vb[:name].class  # => RASN1::Types::ObjectId
+      #   vb[:name].value  # => "1.2.3.4"
       # @author Sylvain Daubert
+      # @author LemonTree55
       class VarBind < RASN1::Model
         sequence :varbind,
                  content: [objectid(:name),
@@ -72,7 +122,12 @@ module PacketGen
 
       # Class to handle SNMP VariableBindingsList
       #  VarBindList ::= SEQUENCE (SIZE (0..max-bindings)) OF VarBind
+      # This is a sequence of {VarBind}.
+      # @example
+      #  bindings = PacketGen::Header::SNMP::VariableBindings.new
+      #  bindings << { name: "1.2.3.4", value: RASN1::Types::OctetString.new(value: "abc") }
       # @author Sylvain Daubert
+      # @author LemonTree55
       class VariableBindings < RASN1::Model
         sequence_of :bindings, VarBind
 
@@ -124,7 +179,20 @@ module PacketGen
       #              variable-bindings           -- values are sometimes ignored
       #                  VarBindList
       #          }
+      # This class defines a GetRequest SNMP PDU. It defines 4 attributes:
+      # * an +:id+ (request-id, type +RASN1::Types::Integer+),
+      # * an +:error+ (error-status, type +RASN1::Types::Integer with enumeration definition from {ERRORS}),
+      # * an +:error_index+ (type +RASN1::Types::Integer+),
+      # * a +:barbindlist+ (variable-bindings, type {VariableBindings}).
+      #
+      # @example
+      #   req = PacketGen::Header::SNMP::GetRequest.new(id: 1, error: "no_error")
+      #   req[:id].value    #=> 1
+      #   req[:error].value #=> "no_error"
+      #   req[:error].to_i  #=> 0
+      #   req[:varbindlist] << { name: "1.2.3.4", value: RASN1::Types::OctetString.new(value: "abcd") }
       # @author Sylvain Daubert
+      # @author LemonTree55
       class GetRequest < RASN1::Model
         sequence :pdu,
                  implicit: SNMP::PDU_GET, constructed: true,
@@ -140,6 +208,7 @@ module PacketGen
 
       # Class to handle GetNextRequest PDU
       #  GetNextRequest-PDU ::= [1] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class GetNextRequest < GetRequest
         root_options implicit: SNMP::PDU_NEXT
@@ -147,6 +216,7 @@ module PacketGen
 
       # Class to handle GetResponse PDU
       #  GetResponse-PDU ::= [2] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class GetResponse < GetRequest
         root_options implicit: SNMP::PDU_RESPONSE
@@ -154,6 +224,7 @@ module PacketGen
 
       # Class to handle SetRequest PDU
       #  SetRequest-PDU ::= [3] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class SetRequest < GetRequest
         root_options implicit: SNMP::PDU_SET
@@ -177,6 +248,15 @@ module PacketGen
       #                          time-stamp TimeTicks,
       #                          variable-bindings VarBindList
       #                   }
+      # This class defines 6 attributes accessibles through +#[]+:
+      # * +:enterprise+ for request-id (type +RASN1::Types::ObjectId+),
+      # * +:agent_addr+ (type +RASN1::Types::Integer+),
+      # * +:generic_trap+ (type +RASN1::Types::Integer+),
+      # * +:specific_trap+ (type +RASN1::Types::Integer+),
+      # * +:timestamp+ (type +RASN1::Types::Integer+),
+      # * +:varbindlist+ for variable-bindings (type {VariableBindings}).
+      # @author Sylvain Daubert
+      # @author LemonTree55
       class Trapv1 < RASN1::Model
         sequence :trap,
                  implicit: SNMP::PDU_TRAPv1, constructed: true,
@@ -205,7 +285,20 @@ module PacketGen
       #            variable-bindings           -- values are ignored
       #                VarBindList
       #        }
+      #
+      # This class defines 4 values accessibles through +#[]+:
+      # * +:id+ for request-id (type +RASN1::Types::Integer+),
+      # * +:non_repeaters+ (type +RASN1::Types::Integer+),
+      # * +:max_repetitions+ (type +RASN1::Types::Integer+),
+      # * +varbindlist+ for variable-bindings (type {VariableBindings}).
+      # @example
+      #   bulk = PacketGen::Header::SNMP::Bulk.new(id: 1, non_repeaters: 2, max_repetitions: 2)
+      #   bulk[:varbindlist] << { name: '1.2.3.4', value: RASN1::Types::OctetString.new(value: "abcd") }
+      #   bulk[:id].inspect  # => "id INTEGER: 1"
+      #   bulk[:id].value    # => 1
+      #   bulk[:varbindlist][0][:name].value  # => "1.2.3.4"
       # @author Sylvain Daubert
+      # @author LemonTree55
       class Bulk < RASN1::Model
         sequence :bulkpdu,
                  implicit: SNMP::PDU_BULK, constructed: true,
@@ -217,6 +310,7 @@ module PacketGen
 
       # Class to handle InformRequest PDU
       #  InformRequest-PDU ::= [6] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class InformRequest < GetRequest
         root_options implicit: SNMP::PDU_INFORM
@@ -224,6 +318,7 @@ module PacketGen
 
       # Class to handle Trapv2 PDU
       #  SNMPv2-Trap-PDU ::= [7] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class Trapv2 < GetRequest
         root_options implicit: SNMP::PDU_TRAPv2
@@ -231,6 +326,7 @@ module PacketGen
 
       # Class to handle Report PDU
       #  Report-PDU ::= [8] IMPLICIT PDU   -- PDU definition: see GetRequest
+      # @see GetRequest
       # @author Sylvain Daubert
       class Report < GetRequest
         root_options implicit: SNMP::PDU_REPORT
@@ -248,7 +344,10 @@ module PacketGen
       #             snmpV2-trap      [7] IMPLICIT PDU,
       #             report           [8] IMPLICIT PDU
       #           }
+      # This class is a wrapper. It contains one of {GetRequest}, {GetNextRequest}, {GetResponse}, {SetRequest},
+      # {Trapv1}, {Bulk}, {InformRequest}, {Trapv2} or {Report}.
       # @author Sylvain Daubert
+      # @author LemonTree55
       class PDUs < RASN1::Model
         choice :pdus,
                content: [model(:get_request, GetRequest),
@@ -285,13 +384,13 @@ module PacketGen
         data.root.value[data.chosen] = klass.new(options[:pdu])
       end
 
-      # accessor to data payload
-      # @return [ASN1::BinStruct::Choice]
+      # accessor to data payload. Shortcut for +snmp[:data]+.
+      # @return [ASN1::Types::Choice]
       def data
         @elements[:data]
       end
 
-      # shortcut to PDU
+      # shortcut to PDU (+snmp[:data].chosen_value+).
       # @return [GetRequest, Bulk, Trapv1, nil] return `nil` if no CHOICE was done
       def pdu
         if data.chosen.nil?
@@ -301,6 +400,8 @@ module PacketGen
         end
       end
 
+      # Inspect SNMP header
+      # @return [String]
       def inspect
         str = super
         str << Inspect.shift_level
@@ -316,7 +417,7 @@ module PacketGen
       #       directly called
       # @param [Packet] packet
       # @return [void]
-      # @since 2.7.0 Set UDP sport according to bindings, only if sport is 0.
+      # @since 2.7.0 Set UDP sport according to bindings, only if sport is not set yet (i.e. is zero).
       #  Needed by new bind API.
       def added_to_packet(packet)
         return unless packet.is?('UDP')

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

@@ -90,7 +90,9 @@ module PacketGen
           end
         end
 
+        # @private
         alias old_set_value value=
+
         # Setter for value attribute
         # @param[String,Integer] val
         # @return [String, Integer]
@@ -159,6 +161,7 @@ module PacketGen
           self[:value] = BinStruct::Int16.new(value: options[:value])
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "MSS:#{value}"
@@ -177,6 +180,7 @@ module PacketGen
           self[:value] = BinStruct::Int8.new(value: options[:value])
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "WS:#{value}"
@@ -208,6 +212,7 @@ module PacketGen
           self[:value] = BinStruct::Int32.new(value: options[:value])
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "WS:#{value}"
@@ -226,6 +231,7 @@ module PacketGen
           self[:value] = BinStruct::Int32.new(value: options[:value])
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "WS:#{value}"
@@ -244,6 +250,7 @@ module PacketGen
           self[:value].read(options[:value] || "\0" * 8)
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           value, echo_reply = self[:value].unpack('NN')

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

@@ -11,8 +11,16 @@ require_relative 'option'
 module PacketGen
   module Header
     class TCP
-      # Container for TCP options in {TCP TCP header}.
+      # Container for TCP {Option options} in {TCP TCP header}.
       # @author Sylvain Daubert
+      # @since 1.0.0
+      # @since 4.1.0 +#<<+ accepts +:kind+ parameter in hash
+      # @example Add an option from a hash
+      #   opts = PacketGen::Header::TCP::Options.new
+      #   # Option kind may be set using :opt
+      #   opts << { opt: 'MSS', value: 1250 }
+      #   # It may aldo be set using :kind
+      #   opts << { kind: 'EOL' }
       class Options < BinStruct::Array
         set_of Option
 
@@ -34,8 +42,8 @@ module PacketGen
         private
 
         def record_from_hash(hsh)
-          if hsh.key? :opt
-            klassname = hsh.delete(:opt)
+          if hsh.key?(:opt) || hsh.key?(:kind)
+            klassname = hsh.delete(:opt) || hsh.delete(:kind)
             raise ArgumentError, 'opt should be a TCP::Option subclass' unless TCP.const_defined?(klassname)
 
             klass = TCP.const_get(klassname)