packetgen 3.3.3 → 4.1.0

data/lib/packetgen/header/dot11/management.rb

@@ -16,45 +16,48 @@ module PacketGen
       # (management frame).
       #
       # A IEEE 802.11 management header consists of:
-      # * a {#frame_ctrl} ({Types::Int16}),
-      # * a {#id}/duration ({Types::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} ({Types::Int16}),
-      # * a {#body} (a {Types::String} or another {Base} class),
-      # * and a Frame check sequence ({#fcs}, of type {Types::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
         # @see Base#initialize
         def initialize(options={})
           super({ type: 0 }.merge!(options))
-          @applicable_fields -= %i[mac4 qos_ctrl ht_ctrl]
-          define_applicable_fields
+          @applicable_attributes -= %i[mac4 qos_ctrl ht_ctrl]
+          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]
         # @since 2.1.3
         def add_element(type:, value:)
-          raise FormatError, 'Before adding an Element, you have to add a Dot11::SubMngt subclass instance' unless self[:body].is_a? SubMngt
+          raise FormatError, 'Before adding an Element, you have to add a Dot11::SubMngt subclass instance' unless self[:body].is_a?(SubMngt)
 
           self[:body].elements << { type: type, value: value }
           self

data/lib/packetgen/header/dot11/sub_mngt.rb

@@ -19,22 +19,9 @@ module PacketGen
       # may be accessed through {#elements}.
       # @author Sylvain Daubert
       class SubMngt < Base
+        # Elements of submngt header
         # @return [Array<Element>]
-        define_field :elements, ArrayOfElements
-
-        # Add an {Element} to header
-        # @param [Integer,String] type element type
-        # @param [Object] value element value
-        # @return [self]
-        # @since 2.1.3
-        # @since 3.1.1 #elements in no more an Array but an {ArrayOfElements}
-        # @deprecated Prefer use of +submngt.element << {type: type, value: value}+
-        def add_element(type:, value:)
-          Deprecation.deprecated(self.class, __method__, 'elements')
-          element = Element.new(type: type, value: value)
-          self.elements << element
-          self
-        end
+        define_attr :elements, ArrayOfElements
       end
 
       # IEEE 802.11 Association Request frame
@@ -42,16 +29,16 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 0.
       #
       # Add fields:
-      # * {#cap} ({Types::Int16le}),
-      # * {#listen_interval} ({Types::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#listen_interval} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class AssoReq < SubMngt
         # @!attribute cap
         #  @return [Integer] 16-bit capabillities word
-        define_field_before :elements, :cap, Types::Int16le
+        define_attr_before :elements, :cap, BinStruct::Int16le
         # @!attribute listen_interval
         #  @return [Integer] 16-bit listen interval value
-        define_field_before :elements, :listen_interval, Types::Int16le, default: 0x00c8
+        define_attr_before :elements, :listen_interval, BinStruct::Int16le, default: 0x00c8
       end
       Header.add_class AssoReq
       Management.bind AssoReq, type: 0, subtype: 0
@@ -61,20 +48,20 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 1.
       #
       # Add fields:
-      # * {#cap} ({Types::Int16le}),
-      # * {#status} ({Types::Int16le}),
-      # * {#aid} ({Types::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+),
+      # * {#aid} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class AssoResp < SubMngt
         # @!attribute cap
         #  @return [Integer] 16-bit capabillities word
-        define_field_before :elements, :cap, Types::Int16le
+        define_attr_before :elements, :cap, BinStruct::Int16le
         # @!attribute status
         #  @return [Integer] 16-bit status word
-        define_field_before :elements, :status, Types::Int16le
+        define_attr_before :elements, :status, BinStruct::Int16le
         # @!attribute aid
         #  @return [Integer] 16-bit AID word
-        define_field_before :elements, :aid, Types::Int16le
+        define_attr_before :elements, :aid, BinStruct::Int16le
       end
       Header.add_class AssoResp
       Management.bind AssoResp, type: 0, subtype: 1
@@ -84,14 +71,14 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 2.
       #
       # Add fields:
-      # * {#cap} ({Types::Int16le}),
-      # * {#listen_interval} ({Types::Int16le}),
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#listen_interval} (+BinStruct::Int16le+),
       # * {#current_ap} ({Eth::MacAddr}).
       # @author Sylvain Daubert
       class ReAssoReq < AssoReq
         # @!attribute current_ap
         #  @return [Eth::MAcAddr]
-        define_field_before :elements, :current_ap, Eth::MacAddr
+        define_attr_before :elements, :current_ap, Eth::MacAddr
       end
       Header.add_class ReAssoReq
       Management.bind ReAssoReq, type: 0, subtype: 2
@@ -101,9 +88,9 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 3.
       #
       # Add fields:
-      # * {#cap} ({Types::Int16le}),
-      # * {#status} ({Types::Int16le}),
-      # * {#aid} ({Types::Int16le}).
+      # * {#cap} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+),
+      # * {#aid} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class ReAssoResp < AssoResp
       end
@@ -126,20 +113,20 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 5.
       #
       # Add fields:
-      # * {#timestamp} ({Types::Int64le}),
-      # * {#beacon_interval} ({Types::Int16le}),
-      # * {#cap} ({Types::Int16le}).
+      # * {#timestamp} (+BinStruct::Int64le+),
+      # * {#beacon_interval} (+BinStruct::Int16le+),
+      # * {#cap} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class ProbeResp < SubMngt
         # @!attribute timestamp
         #  @return [Integer] 64-bit timestamp
-        define_field_before :elements, :timestamp, Types::Int64le
+        define_attr_before :elements, :timestamp, BinStruct::Int64le
         # @!attribute beacon_interval
         #  @return [Integer] 16-bit beacon interval value
-        define_field_before :elements, :beacon_interval, Types::Int16le, default: 0x0064
+        define_attr_before :elements, :beacon_interval, BinStruct::Int16le, default: 0x0064
         # @!attribute cap
         #  @return [Integer] 16-bit capabillities word
-        define_field_before :elements, :cap, Types::Int16le
+        define_attr_before :elements, :cap, BinStruct::Int16le
       end
       Header.add_class ProbeResp
       Management.bind ProbeResp, type: 0, subtype: 5
@@ -149,20 +136,20 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 8.
       #
       # Add fields:
-      # * {#timestamp} ({Types::Int64le}),
-      # * {#interval} ({Types::Int16le}),
-      # * {#cap} ({Types::Int16le}).
+      # * {#timestamp} (+BinStruct::Int64le+),
+      # * {#interval} (+BinStruct::Int16le+),
+      # * {#cap} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Beacon < SubMngt
         # @!attribute timestamp
         #  @return [Integer] 64-bit timestamp
-        define_field_before :elements, :timestamp, Types::Int64le
+        define_attr_before :elements, :timestamp, BinStruct::Int64le
         # @!attribute interval
         #  @return [Integer] 16-bit interval value
-        define_field_before :elements, :interval, Types::Int16le, default: 0x64
+        define_attr_before :elements, :interval, BinStruct::Int16le, default: 0x64
         # @!attribute cap
         #  @return [Integer] 16-bit capabillities word
-        define_field_before :elements, :cap, Types::Int16le
+        define_attr_before :elements, :cap, BinStruct::Int16le
       end
       Header.add_class Beacon
       Management.bind Beacon, type: 0, subtype: 8
@@ -182,12 +169,12 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 10.
       #
       # Add fields:
-      # * {#reason} ({Types::Int16le}).
+      # * {#reason} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Disas < SubMngt
         # @!attribute reason
         #  @return [Integer] 16-bit reason value
-        define_field_before :elements, :reason, Types::Int16le
+        define_attr_before :elements, :reason, BinStruct::Int16le
       end
       Header.add_class Disas
       Management.bind Disas, type: 0, subtype: 10
@@ -197,20 +184,20 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 11.
       #
       # Add fields:
-      # * {#algo} ({Types::Int16le}),
-      # * {#seqnum} ({Types::Int16le}),
-      # * {#status} ({Types::Int16le}).
+      # * {#algo} (+BinStruct::Int16le+),
+      # * {#seqnum} (+BinStruct::Int16le+),
+      # * {#status} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class Auth < SubMngt
         # @!attribute algo
         #  @return [Integer] 16-bit algo value
-        define_field_before :elements, :algo, Types::Int16le
+        define_attr_before :elements, :algo, BinStruct::Int16le
         # @!attribute seqnum
         #  @return [Integer] 16-bit seqnum value
-        define_field_before :elements, :seqnum, Types::Int16le
+        define_attr_before :elements, :seqnum, BinStruct::Int16le
         # @!attribute status
         #  @return [Integer] 16-bit status word
-        define_field_before :elements, :status, Types::Int16le
+        define_attr_before :elements, :status, BinStruct::Int16le
       end
       Header.add_class Auth
       Management.bind Auth, type: 0, subtype: 11
@@ -220,12 +207,12 @@ module PacketGen
       # Specialize {Dot11::Management} with +subtype+ set to 12.
       #
       # Add fields:
-      # * {#reason} ({Types::Int16le}).
+      # * {#reason} (+BinStruct::Int16le+).
       # @author Sylvain Daubert
       class DeAuth < SubMngt
         # @!attribute reason
         #  @return [Integer] 16-bit reason value
-        define_field_before :elements, :reason, Types::Int16le
+        define_attr_before :elements, :reason, BinStruct::Int16le
       end
       Header.add_class DeAuth
       Management.bind DeAuth, type: 0, subtype: 12