packetgen 1.3.0 → 1.4.0

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

@@ -0,0 +1,59 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class Dot11
+
+      # IEEE 802.11 control frame header
+      # @author Sylvain Daubert
+      class Control < Dot11
+
+        # Control subtypes
+        SUBTYPES = {
+          7  => 'Wrapper',
+          8  => 'Block Ack Request',
+          9  => 'Block Ack',
+          10 => 'PS-Poll',
+          11 => 'RTS',
+          12 => 'CTS',
+          13 => 'Ack',
+          14 => 'CF-End',
+          15 => 'CF-End+CF-Ack'
+        }.freeze
+
+        # Control subtypes with mac2 field
+        SUBTYPES_WITH_MAC2 = [9, 10, 11, 14, 15].freeze
+
+        # @param [Hash] options
+        # @see Base#initialize
+        def initialize(options={})
+          super({type: 1}.merge!(options))
+          @applicable_fields -= %i(mac3 sequence_ctrl mac4 qos_ctrl ht_ctrl)
+          define_applicable_fields
+        end
+
+        # Get human readable subtype
+        # @return [String]
+        def human_subtype
+          SUBTYPES[subtype] || subtype.to_s
+        end
+
+        private
+
+        def define_applicable_fields
+          super
+          if @applicable_fields.include? :mac2
+            @applicable_fields -= %i(mac2) unless SUBTYPES_WITH_MAC2.include? self.subtype
+          elsif SUBTYPES_WITH_MAC2.include? self.subtype
+            sz = self.sz
+            @applicable_fields[3, 0] = :mac2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class Dot11
+
+      # IEEE 802.11 data frame header
+      # @author Sylvain Daubert
+      class Data < Dot11
+
+        # @param [Hash] options
+        # @see Base#initialize
+        def initialize(options={})
+          super({type: 2}.merge!(options))
+          @applicable_fields -= %i(mac4 qos_ctrl ht_ctrl)
+          define_applicable_fields
+        end
+
+        private
+
+        def define_applicable_fields
+          super
+          if subtype >= 8 and !@applicable_fields.include? :qos_ctrl
+            # Insert after mac4, if present
+            # else insert after sequence_ctrl
+            if @applicable_fields.include? :mac4
+              idx = @applicable_fields.index(:mac4)
+              @applicable_fields[idx, 0] = :qos_ctrl
+            else
+              @applicable_fields[6, 0] = :qos_ctrl
+            end
+          elsif subtype < 8
+            @applicable_fields -= %i(qos_ctrl)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class Dot11
+
+      # IEEE 802.11 information element
+      # @author Sylvain Daubert
+      class Element < Types::TLV
+        # Known element types
+        TYPES = {
+          0 =>   'SSID',
+          1 =>   'Rates',
+          2 =>   'FHset',
+          3 =>   'DSset',
+          4 =>   'CFset',
+          5 =>   'TIM',
+          6 =>   'IBSSset',
+          16 =>  'challenge',
+          42 =>  'ERPinfo',
+          46 =>  'QoS Cap.',
+          47 =>  'ERPinfo',
+          48 =>  'RSNinfo',
+          50 =>  'ESRates',
+          68 =>  'reserved',
+          221 => 'vendor'
+        }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class Dot11
+
+      # IEEE 802.11 management frame header
+      # @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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,178 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class Dot11
+
+      # @abstract Base class for all subtype management frames
+      # @author Sylvain Daubert
+      class SubMngt < Base
+        # @return [Array<Element>]
+        attr_accessor :elements
+
+        # @param [Hash] options
+        # @see Base#initialize
+        def initialize(options={})
+          super
+          @elements = []
+        end
+
+        # Populate object from binary string
+        # @param [String] str
+        # @return [SubMngt] self
+        def read(str)
+          super
+          read_elements str[sz, str.size] || ''
+          self
+        end
+
+        # @return [String]
+        def to_s
+          super + @elements.map(&:to_s).join
+        end
+
+        # @return [String]
+        def inspect
+          str = super
+          str << Inspect.dashed_line('Dot11 Elements', level=3)
+          @elements.each do |el|
+            str << Inspect.shift_level(4) << el.to_human << "\n"
+          end
+          str
+        end
+
+        private
+
+        def read_elements(str)
+          start = 0
+          elsz = Element.new.sz
+          while str.size - start >= elsz  do
+            el = Element.new.read(str[start, str.size])
+            @elements << el
+            start += el.sz
+          end
+        end
+      end
+
+      # IEEE 802.11 Association Request frame
+      class AssoReq < SubMngt
+        # @!attribute cap
+        #  @return [Integer] 16-bit capabillities word
+        define_field :cap, Types::Int16le
+        # @!attribute listen_interval
+        #  @return [Integer] 16-bit listen interval value
+        define_field :listen_interval, Types::Int16le, default: 0x00c8
+      end
+      Header.add_class AssoReq
+      Management.bind_header AssoReq, op: :and, type: 0, subtype: 0
+
+      # IEEE 802.11 Association Response frame
+      class AssoResp < SubMngt
+        # @!attribute cap
+        #  @return [Integer] 16-bit capabillities word
+        define_field :cap, Types::Int16le
+        # @!attribute status
+        #  @return [Integer] 16-bit status word
+        define_field :status, Types::Int16le
+        # @!attribute aid
+        #  @return [Integer] 16-bit AID word
+        define_field :aid, Types::Int16le
+      end
+      Header.add_class AssoResp
+      Management.bind_header AssoResp, op: :and, type: 0, subtype: 1
+
+      # IEEE 802.11 ReAssociation Request frame
+      class ReAssoReq < AssoReq
+        # @!attribute current_ap
+        #  @return [Eth::MAcAddr]
+        define_field :current_ap, Eth::MacAddr
+      end
+      Header.add_class ReAssoReq
+      Management.bind_header ReAssoReq, op: :and, type: 0, subtype: 2
+
+      # IEEE 802.11 ReAssociation Response frame
+      class ReAssoResp < AssoResp
+      end
+      Header.add_class ReAssoResp
+      Management.bind_header ReAssoResp, op: :and, type: 0, subtype: 3
+
+      # IEEE 802.11 Probe Request frame
+      class ProbeReq < SubMngt
+      end
+      Header.add_class ProbeReq
+      Management.bind_header ProbeReq, op: :and, type: 0, subtype: 4
+
+      # IEEE 802.11 Probe Response frame
+      class ProbeResp < SubMngt
+        # @!attribute timestamp
+        #  @return [Integer] 64-bit timestamp
+        define_field :timestamp, Types::Int64le
+        # @!attribute beacon_interval
+        #  @return [Integer] 16-bit beacon interval value
+        define_field :beacon_interval, Types::Int16le, default: 0x0064
+        # @!attribute cap
+        #  @return [Integer] 16-bit capabillities word
+        define_field :cap, Types::Int16le
+      end
+      Header.add_class ProbeResp
+      Management.bind_header ProbeResp, op: :and, type: 0, subtype: 5
+
+      # IEEE 802.11 Beacon frame
+      class Beacon < SubMngt
+        # @!attribute timestamp
+        #  @return [Integer] 64-bit timestamp
+        define_field :timestamp, Types::Int64le
+        # @!attribute interval
+        #  @return [Integer] 16-bit interval value
+        define_field :interval, Types::Int16le, default: 0x64
+        # @!attribute cap
+        #  @return [Integer] 16-bit capabillities word
+        define_field :cap, Types::Int16le
+      end
+      Header.add_class Beacon
+      Management.bind_header Beacon, op: :and, type: 0, subtype: 8
+
+      # IEEE 802.11 ATIM frame
+      class ATIM < SubMngt; end
+      Header.add_class ATIM
+      Management.bind_header ATIM, op: :and, type: 0, subtype: 9
+
+      # IEEE 802.11 Disassociation frame
+      class Disas < SubMngt
+        # @!attribute reason
+        #  @return [Integer] 16-bit reason value
+        define_field :reason, Types::Int16le
+      end
+      Header.add_class Disas
+      Management.bind_header Disas, op: :and, type: 0, subtype: 10
+
+      # IEEE 802.11 Authentication frame
+      class Auth < SubMngt
+        # @!attribute algo
+        #  @return [Integer] 16-bit algo value
+        define_field :algo, Types::Int16le
+        # @!attribute seqnum
+        #  @return [Integer] 16-bit seqnum value
+        define_field :seqnum, Types::Int16le
+        # @!attribute status
+        #  @return [Integer] 16-bit status word
+        define_field :status, Types::Int16le
+      end
+      Header.add_class Auth
+      Management.bind_header Auth, op: :and, type: 0, subtype: 11
+
+      # IEEE 802.11 Deauthentication frame
+      class DeAuth < SubMngt
+        # @!attribute reason
+        #  @return [Integer] 16-bit reason value
+        define_field :reason, Types::Int16le
+      end
+      Header.add_class DeAuth
+      Management.bind_header DeAuth, op: :and, type: 0, subtype: 12
+    end
+  end
+end

data/lib/packetgen/header/dot1q.rb

@@ -0,0 +1,42 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+
+    # IEEE 802.1Q VLAN tagging
+    #
+    # A VLAN tag consists of:
+    # * a {#tci Tag Control Information} ({Types::Int16}),
+    # * a {#ethertype} ({Types::Int16}),
+    # * and a body (a {Types::String} or another Header class).
+    #
+    # == Create a Dot1q header
+    #   # Create a IP packet in VLAN #43
+    #   pkt = PacketGen.gen('Eth').add('Dot1q', vid: 43).add('IP')
+    # @author Sylvain Daubert
+    class Dot1q < Base
+      # @!attribute tci
+      #  @return [Integer] 16-bit Tag Control Information
+      define_field :tci, Types::Int16
+      # @!attribute ethertype
+      #  @return [Integer] 16-bit EtherType
+      define_field :ethertype, Types::Int16
+      # @!attribute body
+      #  @return [Types::String,Header::Base]
+      define_field :body, Types::String
+
+      # @!attribute pcp
+      #  @return [Integer] 3-bit Priority Code Point from {#tci}
+      # @!attribute dei
+      #  @return [Boolean] Drop Eligible Indicator from {#tci}
+      # @!attribute vid
+      #  @return [Integer] 12-bit VLAN ID from {#tci}
+      define_bit_fields_on :tci, :pcp, 3, :dei, :vid, 12
+    end
+
+    Eth.bind_header Dot1q, ethertype: 0x8100
+  end
+end

data/lib/packetgen/header/dot1x.rb

@@ -0,0 +1,78 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+
+    # IEEE 802.1X / EAPOL
+    #
+    # A IEEE 802.1X header consists of:
+    # * a {#version} ({Types::Int8}),
+    # * a packet {#type} ({Types::Int8}),
+    # * a {#length} ({Types::Int16}),
+    # * and a body (a {Types::String} or another Header class).
+    # == Create a Dot1x header
+    #   pkt1 = PacketGen.gen('Eth').add('Dot1x', type: 1)
+    #   pkt2 = PacketGen.gen('Eth').add('Dot1x')
+    #   pkt2.dot1x.type = 'EAP Packet'
+    #   pkt2.dot1x.body.read 'body'
+    # @author Sylvain Daubert
+    class Dot1x < Base
+
+      # IEEE 802.1x Ether type
+      ETHERTYPE = 0x888e
+
+      # IEEE 802.1X packet types
+      TYPES = {
+        0 => 'EAP Packet',
+        1 => 'Start',
+        2 => 'Logoff',
+        3 => 'Key',
+        4 => 'Encap-ASF-Alert'
+      }
+
+      # @!attribute version
+      #  @return [Integer] 8-bit Protocol Version
+      define_field :version, Types::Int8, default: 1
+      # @!attribute type
+      #  @return [Integer] 8-bit Packet Type
+      define_field :type, Types::Int8
+      # @!attribute length
+      #  @return [Integer] 16-bit body length
+      define_field :length, Types::Int16
+      # @!attribute body
+      #  @return [Types::String,Header::Base]
+      define_field :body, Types::String
+
+      # @private
+      alias old_type= type=
+
+      # Set type attribute
+      # @param [String,Integer] type
+      # @return [Integer]
+      def type=(type)
+        case type
+        when Integer
+          self.old_type = type
+        else
+          v = TYPES.key(type.to_s)
+          raise ArgumentError, "unknown type #{type}" if v.nil?
+          self.old_type = v
+        end
+      end
+
+      # Get human readable type
+      # @return [String]
+      def human_type
+        v = TYPES[self.type]
+        v = self.type if v.nil?
+        v.to_s
+      end
+    end
+
+    Eth.bind_header Dot1x, ethertype: Dot1x::ETHERTYPE
+    SNAP.bind_header Dot1x, proto_id: Dot1x::ETHERTYPE
+  end
+end