packetgen 2.6.0 → 2.7.0

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class Dot11
-
       # IEEE 802.11 information element
       #
       # An {Element} is a piece of data contained in a Dot11 management frame.

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class Dot11
-
       # IEEE 802.11 management frame header
       #
       # This class make a {Dot11} header with {#type} set to +0+
@@ -25,7 +24,7 @@ module PacketGen
       # * a {#body} (a {Types::String} or another {Base} class),
       # * and a Frame check sequence ({#fcs}, of type {Types::Int32le}).
       #
-      # Management frames should be constructed with more headers from 
+      # Management frames should be constructed with more headers from
       # {SubMngt} subclasses.
       #
       # By example, build a {DeAuth} frame:
@@ -40,12 +39,11 @@ module PacketGen
       #   pkt.dot11_beacon.add_elements(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)
+          super({ type: 0 }.merge!(options))
+          @applicable_fields -= %i[mac4 qos_ctrl ht_ctrl]
           define_applicable_fields
         end
 
@@ -64,6 +62,12 @@ module PacketGen
 
           self
         end
+
+        # Invert mac1 and mac2 (resp. destination address and source address).
+        # @return [self]
+        def reply!
+          self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+        end
       end
     end
   end

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class Dot11
-
       # @abstract Base class for all subtype management frames
       # Subclasses of this class are used to specialize {Management}. A
       # +SubMngt+ class set +subtype+ field in Dot11 header and may add some
@@ -52,7 +51,7 @@ module PacketGen
           end
           str
         end
-        
+
         # Add an {Element} to header
         # @param [Integer,String] type element type
         # @param [Object] value element value
@@ -69,7 +68,7 @@ module PacketGen
         def read_elements(str)
           start = 0
           elsz = Element.new.sz
-          while str.size - start >= elsz  do
+          while str.size - start >= elsz
             el = Element.new.read(str[start, str.size])
             @elements << el
             start += el.sz
@@ -94,7 +93,7 @@ module PacketGen
         define_field :listen_interval, Types::Int16le, default: 0x00c8
       end
       Header.add_class AssoReq
-      Management.bind_header AssoReq, op: :and, type: 0, subtype: 0
+      Management.bind AssoReq, type: 0, subtype: 0
 
       # IEEE 802.11 Association Response frame
       #
@@ -117,7 +116,7 @@ module PacketGen
         define_field :aid, Types::Int16le
       end
       Header.add_class AssoResp
-      Management.bind_header AssoResp, op: :and, type: 0, subtype: 1
+      Management.bind AssoResp, type: 0, subtype: 1
 
       # IEEE 802.11 ReAssociation Request frame
       #
@@ -134,7 +133,7 @@ module PacketGen
         define_field :current_ap, Eth::MacAddr
       end
       Header.add_class ReAssoReq
-      Management.bind_header ReAssoReq, op: :and, type: 0, subtype: 2
+      Management.bind ReAssoReq, type: 0, subtype: 2
 
       # IEEE 802.11 ReAssociation Response frame
       #
@@ -148,7 +147,7 @@ module PacketGen
       class ReAssoResp < AssoResp
       end
       Header.add_class ReAssoResp
-      Management.bind_header ReAssoResp, op: :and, type: 0, subtype: 3
+      Management.bind ReAssoResp, type: 0, subtype: 3
 
       # IEEE 802.11 Probe Request frame
       #
@@ -159,7 +158,7 @@ module PacketGen
       class ProbeReq < SubMngt
       end
       Header.add_class ProbeReq
-      Management.bind_header ProbeReq, op: :and, type: 0, subtype: 4
+      Management.bind ProbeReq, type: 0, subtype: 4
 
       # IEEE 802.11 Probe Response frame
       #
@@ -182,7 +181,7 @@ module PacketGen
         define_field :cap, Types::Int16le
       end
       Header.add_class ProbeResp
-      Management.bind_header ProbeResp, op: :and, type: 0, subtype: 5
+      Management.bind ProbeResp, type: 0, subtype: 5
 
       # IEEE 802.11 Beacon frame
       #
@@ -205,7 +204,7 @@ module PacketGen
         define_field :cap, Types::Int16le
       end
       Header.add_class Beacon
-      Management.bind_header Beacon, op: :and, type: 0, subtype: 8
+      Management.bind Beacon, type: 0, subtype: 8
 
       # IEEE 802.11 ATIM frame
       #
@@ -215,7 +214,7 @@ module PacketGen
       # @author Sylvain Daubert
       class ATIM < SubMngt; end
       Header.add_class ATIM
-      Management.bind_header ATIM, op: :and, type: 0, subtype: 9
+      Management.bind ATIM, type: 0, subtype: 9
 
       # IEEE 802.11 Disassociation frame
       #
@@ -230,7 +229,7 @@ module PacketGen
         define_field :reason, Types::Int16le
       end
       Header.add_class Disas
-      Management.bind_header Disas, op: :and, type: 0, subtype: 10
+      Management.bind Disas, type: 0, subtype: 10
 
       # IEEE 802.11 Authentication frame
       #
@@ -253,7 +252,7 @@ module PacketGen
         define_field :status, Types::Int16le
       end
       Header.add_class Auth
-      Management.bind_header Auth, op: :and, type: 0, subtype: 11
+      Management.bind Auth, type: 0, subtype: 11
 
       # IEEE 802.11 Deauthentication frame
       #
@@ -268,7 +267,7 @@ module PacketGen
         define_field :reason, Types::Int16le
       end
       Header.add_class DeAuth
-      Management.bind_header DeAuth, op: :and, type: 0, subtype: 12
+      Management.bind DeAuth, type: 0, subtype: 12
     end
   end
 end

data/lib/packetgen/header/dot1q.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # IEEE 802.1Q VLAN tagging
     #
     # A VLAN tag consists of:
@@ -19,6 +18,7 @@ module PacketGen
     #   # Create a IP packet in VLAN #43
     #   pkt = PacketGen.gen('Eth').add('Dot1q', vid: 43).add('IP')
     # @author Sylvain Daubert
+    # @since 1.4.0
     class Dot1q < Base
       # @!attribute tci
       #  @return [Integer] 16-bit Tag Control Information
@@ -39,6 +39,6 @@ module PacketGen
       define_bit_fields_on :tci, :pcp, 3, :dei, :vid, 12
     end
 
-    Eth.bind_header Dot1q, ethertype: 0x8100
+    Eth.bind Dot1q, ethertype: 0x8100
   end
 end

data/lib/packetgen/header/dot1x.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # IEEE 802.1X / EAPOL
     #
     # A IEEE 802.1X header consists of:
@@ -21,8 +20,8 @@ module PacketGen
     #   pkt2.dot1x.type = 'EAP Packet'
     #   pkt2.dot1x.body.read 'body'
     # @author Sylvain Daubert
+    # @since 1.4.0
     class Dot1x < Base
-
       # IEEE 802.1x Ether type
       ETHERTYPE = 0x888e
 
@@ -74,7 +73,7 @@ module PacketGen
       end
     end
 
-    Eth.bind_header Dot1x, ethertype: Dot1x::ETHERTYPE
-    SNAP.bind_header Dot1x, proto_id: Dot1x::ETHERTYPE
+    Eth.bind Dot1x, ethertype: Dot1x::ETHERTYPE
+    SNAP.bind Dot1x, proto_id: Dot1x::ETHERTYPE
   end
 end

data/lib/packetgen/header/eap.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # Extensible Authentication Protocol (EAP),
     # {https://tools.ietf.org/html/rfc3748 RFC 3748}
     #
@@ -57,15 +56,14 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.1.4
     class EAP < Base
-
       # EAP known codes
       CODES = {
         'Request'   => 1,
         'Response'  => 2,
         'Success'   => 3,
         'Failure'   => 4
-      }
-      
+      }.freeze
+
       # EAP known request/response types
       TYPES = {
         'Identity'           => 1,
@@ -79,7 +77,7 @@ module PacketGen
         'EAP-FAST'           => 43,
         'Expanded Types'     => 254,
         'Experimental Use'   => 255
-      }
+      }.freeze
 
       # @!attribute code
       #  @return [Integer] 8-bit EAP code
@@ -92,70 +90,65 @@ module PacketGen
       # @!attribute length
       #  @return [Integer] 16-bit length of EAP packet
       define_field :length, Types::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
-      define_field :type, Types::Int8Enum, enum: TYPES, 
-                   optional: ->(eap) { eap.has_type? }
-                   
+      define_field :type, Types::Int8Enum, enum: TYPES,
+                   optional: ->(eap) { eap.type? }
+
       # @!attribute 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
       define_field :vendor_id, Types::Int24,
-                   optional: ->(eap) { eap.has_type? and eap.type == 254 }
-      
+                   optional: ->(eap) { eap.type? && (eap.type == 254) }
+
       # @!attribute 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
       define_field :vendor_type, Types::Int32,
-                   optional: ->(eap) { eap.has_type? and eap.type == 254 }
+                   optional: ->(eap) { eap.type? && (eap.type == 254) }
 
       # @!attribute body
       #  @return [Types::String, Header::Base]
       define_field :body, Types::String
-      
+
       # @return [EAP]
       def initialize(options={})
         super
         calc_length if options[:length].nil?
       end
-      
+
       # @private
       alias old_read read
-      
+
       # Populate object from a binary string
       # @param [String] str
       # @return [Dot11] may return a subclass object if a more specific class
       #   may be determined
       def read(str)
-        if self.class == EAP
-          super str
-
-          if has_type?
-            obj = case self.type
-                  when 4
-                    EAP::MD5.new.read(str)
-                  when 13
-                    EAP::TLS.new.read(str)
-                  when 21
-                    EAP::TTLS.new.read(str)
-                  when 43
-                    EAP::FAST.new.read(str)
-                  else
-                    self
-                  end
-            return obj
-          else
-            return self
-          end
+        super str
+        return self unless self.class == EAP
+        if type?
+          obj = case self.type
+                when 4
+                  EAP::MD5.new.read(str)
+                when 13
+                  EAP::TLS.new.read(str)
+                when 21
+                  EAP::TTLS.new.read(str)
+                when 43
+                  EAP::FAST.new.read(str)
+                else
+                  self
+                end
+          obj
         else
-          super str
+          self
         end
-        self
       end
 
       # Get human readable code
@@ -163,49 +156,47 @@ module PacketGen
       def human_code
         self[:code].to_human
       end
-      
+
       # Get human readable type
       # @return [String]
       # @raise [ParseError] not a Request nor a Response packet
       def human_type
-        raise ParseError, 'not a Request nor a Response' unless has_type?
+        raise ParseError, 'not a Request nor a Response' unless type?
         self[:type].to_human
       end
-      
+
       # Is packet a request?
       # @return [Boolean]
       def request?
         code == CODES['Request']
       end
-      
+
       # Is packet a response?
       # @return [Boolean]
       def response?
         code == CODES['Response']
       end
-      
+
       # Is packet a success?
       # @return [Boolean]
       def success?
         code == CODES['Success']
       end
-      
+
       # Is packet a failure?
       # @return [Boolean]
       def failure?
         code == CODES['Failure']
       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
-        if code != 2 and type != 3
-          raise ParseError, 'not a Nak response'
-        end
+        raise ParseError, 'not a Nak response' if (code != 2) && (type != 3)
         body.to_s.unpack('C*')
       end
-      
+
       # Calculate length field from content
       # @return [Integer]
       def calc_length
@@ -214,8 +205,16 @@ module PacketGen
 
       # Say is this EAP header has {#type} field
       # @return [Boolean]
+      # @since 2.7.0
+      def type?
+        [1, 2].include?(self.code)
+      end
+
+      # @deprecated Use {#type?} instead.
+      # @return [Boolean]
       def has_type?
-        [1,2].include?(self.code)
+        Deprecation.deprecated(self.class, __method__, 'type?')
+        type?
       end
 
       # Callback called when a EAP header is added to a packet
@@ -224,13 +223,23 @@ module PacketGen
       # @param [Packet] packet
       # @return [void]
       def added_to_packet(packet)
-        unless packet.respond_to? :eap
-          packet.instance_eval("def eap(arg=nil); header(#{self.class}, arg); end")
+        return if packet.respond_to? :eap
+        packet.instance_eval("def eap(arg=nil); header(#{self.class}, arg); end")
+      end
+
+      # Invert between a request and a response packet. Not action for
+      # others codes.
+      # @return [self]
+      def reply!
+        case self.code
+        when 1 then self.code = 2
+        when 2 then self.code = 1
         end
+        self
       end
     end
-    
-    Dot1x.bind_header EAP, type: 0
+
+    Dot1x.bind EAP, type: 0
   end
 end