packetgen 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b1fc19fea5c7400e6d70e01a83ca68351e646b
-  data.tar.gz: b9ef7b691f66d23d763e7cf03f98aab5314924b5
+  metadata.gz: e306dbee54d246dd2044db6610ba27e3fb539215
+  data.tar.gz: 1103a3a6429fb2b4c8391750cdefa8c7d87ac323
 SHA512:
-  metadata.gz: bddf2bf621ae0ddd6e30d4f1ee25f24b575d4b42b994203baa135cc58d0fac3ecce8c1549966faa381a8049c0585cd8517dc358c0e2399dc0afab1778121ef77
-  data.tar.gz: a02f287f900e5f7d21e845fd26c86b146375a87babc61252f4c73cf63c306ff403f0fef8220594d4b8e0d17a9f5f71bb6f2dbef7e61e49c1cc1472aed2180d63
+  metadata.gz: 592a69c18ea009c84374aa79125134ee136f0ed9050aefb8610ff484447f9cddc66685fcc3449733d2f6a1160de403d51a4465689029090815db45cdf292e12f
+  data.tar.gz: cf57d3f41ea4eaa30964086ec2a1127a0f2aae14a291b2fc7476819484aaa0a14a5c0681bda1f68ad7ba4aa84edc6196cb7684054ea94c22c91a5626eb2ac533

data/.gitignore

@@ -9,4 +9,4 @@
 /tmp/
 /vendor/
 *~
-
+tags

data/README.md

@@ -41,6 +41,11 @@ PacketGen.gen('Eth', src: '00:00:00:00:00:01', dst: '00:00:00:00:00:02').to_w
 PacketGen.gen('IP', src: '192.168.1.1', dst: '192.168.1.2').to_w
 # send forged IP packet over Ethernet
 PacketGen.gen('Eth', src: '00:00:00:00:00:01', dst: '00:00:00:00:00:02').add('IP').to_w('eth1')
+# send a IEEE 802.11 frame
+PacketGen.gen('RadioTap').
+          add('Dot11::Management', mac1: client, mac2: bssid, mac3: bssid).
+          add('Dot11::DeAuth', reason: 7).
+          to_w('wlan0')
 ```
 
 ### Parse packets from binary data
@@ -148,9 +153,11 @@ classes. A special `config` object gives local network configuration:
 
 If `pry` gem is installed, it is used as backend for `pgconsole`, else IRB is used.
 
-## API documentation
+## See also
 
-see http://www.rubydoc.info/gems/packetgen
+Wiki: https://github.com/sdaubert/packetgen/wiki
+
+API documentation: http://www.rubydoc.info/gems/packetgen
 
 ## Pull requests?
 
@@ -165,4 +172,4 @@ Copyright © 2016 Sylvain Daubert
 All original code maintains its copyright from its original authors and licensing.
 
 This is mainly for PcapNG (originally copied from [PacketFu](https://github.com/packetfu/packetfu),
-but i am the original author).
+but i am the original author.

data/bin/pgconsole

@@ -2,6 +2,7 @@
 
 require 'packetgen'
 require 'packetgen/config'
+require 'packetgen/utils'
 
 use_pry = false
 begin
@@ -13,28 +14,25 @@ rescue LoadError
   require 'irb/completion'
 end
 
-include PacketGen
+class PgConsole
+  include PacketGen
+  include Utils
 
-def parse(binary_str, first_header: nil)
-  Packet.parse binary_str, first_header: first_header
-end
-
-def capture(options={})
-  Packet.capture(options) { |packet| yield packet if block_given? }
-end
-
-def read(filename)
-  Packet.read filename
-end
-
-def write(filename, packets)
-  Packet.write filename, packets
-end
+  def config
+    PacketGen::Config.instance
+  end
 
-@config = PacketGen::Config.new
+  PacketGen.singleton_methods.each do |m|
+    define_method m, PacketGen.method(m).to_proc
+  end
 
-def config
-  @config
+  Utils.singleton_methods.each do |m|
+    define_method m, Utils.method(m).to_proc
+  end
+  
+  def get_binding
+    binding
+  end
 end
 
 def start_message(use_pry)
@@ -47,21 +45,21 @@ if use_pry
   Pry.config.prompt = [
     proc { |target_self, nest_level, pry|
       "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})#{":#{nest_level}" unless nest_level.zero?}> "
-    },                                                                           
-    proc { |target_self, nest_level, pry|                                           
-      "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})#{":#{nest_level}" unless nest_level.zero?}* "       
+    },
+    proc { |target_self, nest_level, pry|
+      "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})#{":#{nest_level}" unless nest_level.zero?}* "
     }
   ]
   Pry.config.prompt_name = 'pg'
-  Pry.start
+  PgConsole.new.get_binding.pry
 else
   IRB.setup nil
-  irb = IRB::Irb.new(IRB::WorkSpace.new(binding))
+  irb = IRB::Irb.new(IRB::WorkSpace.new(PgConsole.new.get_binding))
   IRB.conf[:MAIN_CONTEXT] = irb.context
   irb.context.auto_indent_mode = true
-  irb.context.prompt_i = "pg(%m)>"
-  irb.context.prompt_s = "pg(%m)*"
-  irb.context.prompt_c = "pg(%m)*"
+  irb.context.prompt_i = "pg> "
+  irb.context.prompt_s = "pg* "
+  irb.context.prompt_c = "pg* "
 
   trap("SIGINT") do
     irb.signal_handle
@@ -75,4 +73,3 @@ else
     IRB.irb_at_exit
   end
 end
-   

data/lib/packetgen/config.rb

@@ -3,52 +3,68 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-require 'network_interface'
 require 'socket'
+require 'singleton'
+require 'network_interface'
 
 module PacketGen
 
   # Config class to provide +config+ object to pgconsole
   # @author Sylvain Daubert
   # @author Kent 'picat' Gruber
+  # @since 2.1.3 Config is singleton
   class Config
+    include Singleton
 
     # Default network interface
     # @return [String]
-    attr_reader :iface
-    # MAC address of default interface
-    # @return [String]
-    attr_reader :hwaddr
-    # IP address of default interface
-    # @return [String]
-    attr_reader :ipaddr
-    # IPv6 address of default interface
-    # @return [String]
-    attr_reader :ip6addr
+    attr_reader :default_iface
+
+    def initialize
+      begin
+        default_iface = Pcap.lookupdev
+      rescue PCAPRUB::BindingError
+        default_iface = NetworkInterface.interfaces.select { |i| i =~ /lo/ }.first
+      end
+      @default_iface = default_iface
+      @hwaddr = {}
+      @ipaddr = {}
+      @ip6addr = {}
 
-    # Create a configuration object. If +iface+ is not set,
-    # attempt to find it automatically or default to the
-    # first available loopback interface.
-    # @param [String,nil] iface
-    def initialize(iface=nil)
-      if iface.nil?
-        begin
-          iface = Pcap.lookupdev
-        rescue PCAPRUB::BindingError
-          iface = NetworkInterface.interfaces.select { |iface| iface =~ /lo/ }.first
+      NetworkInterface.interfaces.each do |iface|
+        addresses = NetworkInterface.addresses(iface)
+        @hwaddr[iface] = case RbConfig::CONFIG['target_os']
+                  when /darwin/
+                    addresses[Socket::AF_LINK][0]['addr'] if addresses[Socket::AF_LINK]
+                  else
+                    addresses[Socket::AF_PACKET][0]['addr'] if addresses[Socket::AF_PACKET]
+                  end
+        @ipaddr[iface] = addresses[Socket::AF_INET][0]['addr'] if addresses[Socket::AF_INET]
+        if addresses[Socket::AF_INET6]
+          @ip6addr[iface] = addresses[Socket::AF_INET6].map { |hsh| hsh['addr'] }
         end
       end
-      @iface = iface
+    end
 
-      addresses = NetworkInterface.addresses(iface)
-      @hwaddr = case RbConfig::CONFIG['target_os']
-                when /darwin/
-                  addresses[Socket::AF_LINK][0]['addr'] if addresses[Socket::AF_LINK]
-                else
-                  addresses[Socket::AF_PACKET][0]['addr'] if addresses[Socket::AF_PACKET]
-                end
-      @ipaddr = addresses[Socket::AF_INET][0]['addr'] if addresses[Socket::AF_INET]
-      @ip6addr = addresses[Socket::AF_INET6][0]['addr'] if addresses[Socket::AF_INET6]
+    # Get MAC address for given network interface
+    # @param [String,nil] iface network interface. Il +nil+, use default one.
+    # @return [String]
+    def hwaddr(iface=nil)
+      @hwaddr[iface || @default_iface]
+    end
+    
+    # Get IP address for given network interface
+    # @param [String,nil] iface network interface. Il +nil+, use default one.
+    # @return [String]
+    def ipaddr(iface=nil)
+      @ipaddr[iface || @default_iface]
+    end
+        
+    # Get IPv6 addresses for given network interface
+    # @param [String,nil] iface network interface. Il +nil+, use default one.
+    # @return [Array<String>]
+    def ip6addr(iface=nil)
+      @ip6addr[iface || @default_iface]
     end
   end
 end

data/lib/packetgen/header/arp.rb

@@ -48,7 +48,7 @@ module PacketGen
       # @!attribute op
       #  16-bit operation code
       #  # @return [Integer]
-      define_field :op, Types::Int16, default: 1
+      define_field :op, Types::Int16Enum, enum: { 'request' => 1, 'reply' => 2 }
       # @!attribute sha
       #  source hardware address
       #  @return [Eth::MacAddr]
@@ -119,4 +119,3 @@ module PacketGen
     Dot1q.bind_header ARP, ethertype: 0x806
   end
 end
-

data/lib/packetgen/header/asn1_base.rb

@@ -8,6 +8,8 @@ module PacketGen
   module Header
 
     # @abstract Base class for ASN.1 header types.
+    #    This class implement minimal {Base} API to mimic a {Base} object.
+    #
     #    Subclasses may define magic methods:
     #    * {#parse?}.
     # @author Sylvain Daubert
@@ -56,6 +58,8 @@ module PacketGen
         @method_name = protocol_name.downcase.sub(/::/, '_')
       end
 
+      # Called by {Packet#parse} when guessing first header to check if header
+      # is correct
       # @return [true]
       def parse?
         true

data/lib/packetgen/header/dns/question.rb

@@ -6,19 +6,6 @@ module PacketGen
       # @author Sylvain Daubert
       class Question < Base
 
-        # @!attribute name
-        #  Question domain name
-        #  @return [String]
-        define_field :name, Name, default: '.'
-        # @!attribute type
-        #  16-bit question type
-        #  @return [Integer]
-        define_field :type, Types::Int16, default: 1
-        # @!attribute rrclass
-        #  16-bit question class
-        #  @return [Integer]
-        define_field :rrclass, Types::Int16, default: 1
-
         # Ressource Record types
         TYPES = {
           'A'        => 1,
@@ -49,7 +36,7 @@ module PacketGen
           'TKEY'     => 249,
           'TSIG'     => 250,
           '*'        => 255
-        }
+        }.freeze
 
         # Ressource Record classes
         CLASSES = {
@@ -58,7 +45,20 @@ module PacketGen
           'HS'   => 4,
           'NONE' => 254,
           '*'    => 255
-        }
+        }.freeze
+
+        # @!attribute name
+        #  Question domain name
+        #  @return [String]
+        define_field :name, Name, default: '.'
+        # @!attribute type
+        #  16-bit question type
+        #  @return [Integer]
+        define_field :type, Types::Int16Enum, default: 1, enum: TYPES
+        # @!attribute rrclass
+        #  16-bit question class
+        #  @return [Integer]
+        define_field :rrclass, Types::Int16Enum, default: 1, enum: CLASSES
 
         # @param [DNS] dns
         # @param [Hash] options
@@ -72,20 +72,6 @@ module PacketGen
           self.rrclass = options[:rrclass] if options[:rrclass]
         end
 
-        # Setter for type
-        # @param [Integer] val
-        # @return [Integer,String]
-        def type=(val)
-          v = case val
-              when String
-                self.class::TYPES[val.upcase]
-              else
-                val
-              end
-          raise ArgumentError, "unknown type #{val.inspect}" unless v
-          self[:type].read v
-        end
-
         # Setter for class
         # @param [Integer] val
         # @return [Integer,String]
@@ -109,7 +95,7 @@ module PacketGen
 
         # Get human readable type
         # @return [String]
-          def human_type
+        def human_type
           self.class::TYPES.key(type) || "0x%04x" % type
         end
 

data/lib/packetgen/header/dot11.rb

@@ -50,7 +50,14 @@ module PacketGen
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 0
+        version == 0 and length >= 8
+      end
+
+      # Calculate length field
+      # @return [Integer] calculated length
+      # @since 2.1.3
+      def calc_length
+        self[:length].value = self.sz - self[:body].sz
       end
 
       # send PPI packet on wire. Dot11 FCS trailer should be set.
@@ -64,7 +71,7 @@ module PacketGen
     end
     self.add_class PPI
 
-    # Radiotap header
+    # Radiotap header (see http://www.radiotap.org/)
     # @author Sylvain Daubert
     class RadioTap < Base
       # @!attribute version
@@ -75,7 +82,7 @@ module PacketGen
       define_field :pad, Types::Int8, default: 0
       # @!attribute length
       #  @return [Integer] 16-bit RadioTap header length
-      define_field :length, Types::Int16le
+      define_field :length, Types::Int16le, default: 8
       # @!attribute present_flags
       #  @return [Integer] 32-bit integer
       define_field :present_flags, Types::Int32le
@@ -103,7 +110,14 @@ module PacketGen
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 0
+        version == 0 and length >= 8
+      end
+      
+      # Calculate length field
+      # @return [Integer] calculated length
+      # @since 2.1.3
+      def calc_length
+        self[:length].value = self.sz - self[:body].sz
       end
 
       # send RadioTap packet on wire. Dot11 FCS trailer should be set.
@@ -120,7 +134,7 @@ module PacketGen
     # 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 consists of at least:
+    # A IEEE 802.11 header may consist of at least:
     # * a {#frame_ctrl} ({Types::Int16}),
     # * a {#id}/duration ({Types::Int16le}),
     # * and a {#mac1} ({Eth::MacAddr}).
@@ -134,10 +148,52 @@ module PacketGen
     # * a {#body} (a {Types::String} or another {Base} class),
     # * a Frame check sequence ({#fcs}, of type {Types::Int32le})
     #
-    # == header accessors
+    # == 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,
     # 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.
+    #
+    # === IEEE802.11 control frames
+    # Control frames may be created this way:
+    #   pkt = PacketGen.gen('Dot11::Control', subtype: 13) # Ack control frame
+    #   pkt.dot11_control     # => PacketGen::Header::Dot11::Control
+    #
+    # === IEEE802.11 management frames
+    # Management frames may be created this way:
+    #   pkt = PacketGen.gen('Dot11::Management')
+    #   pkt.dot11_management     # => 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)
+    #
+    # === IEEE802.11 data frames
+    # Data frames may be created this way:
+    #   pkt = PacketGen.gen('Dot11::Data')
+    #   pkt.dot11_data     # => PacketGen::Header::Dot11::Data
+    #
+    # == Parse Dot11 packets
+    # When parsing a Dot11 packet, Dot11 subclass is created from +type+ value.
+    # Dot11 header should then be accessed through +Packet#dot11_management+,
+    # +Packet#dot11_control+ or +Packet#dot11_data+.
+    #
+    # A  +Packet#dot11+ may exist for unknown types.
+    #
+    # == Send Dot11 packets
+    # To send a Dot11 packet, a RadioTap header is needed:
+    #   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.to_w('wlan0')
     # @author Sylvain Daubert
     class Dot11 < Base
 
@@ -211,6 +267,15 @@ module PacketGen
       define_bit_fields_on :frame_ctrl,  :subtype, 4, :type, 2, :proto_version, 2,
                             :order, :wep, :md, :pwmngt, :retry, :mf, :from_ds, :to_ds
 
+
+      # @!attribute sequence_number (12-bit field from {#sequence_ctrl})
+      #  @return [Integer]
+      #  @since 2.1.3
+      # @!attribute fragment_number (4-bit field from {#sequence_ctrl})
+      #  @return [Integer]
+      #  @since 2.1.3
+      define_bit_fields_on :sequence_ctrl, :sequence_number, 12, :fragment_number, 4
+
       alias duration id
       # @private
       alias old_fields fields
@@ -302,7 +367,7 @@ module PacketGen
         pcap = PCAPRUB::Pcap.open_live(iface, PCAP_SNAPLEN, PCAP_PROMISC,
                                        PCAP_TIMEOUT)
         str = self.to_s
-        pcap.inject str << [crc32].pack('V')
+        pcap.inject str
       end
 
       private
@@ -317,7 +382,7 @@ module PacketGen
           unless @applicable_fields.include? :ht_ctrl
             idx = @applicable_fields.index(:body)
             @applicable_fields[idx, 0] = :ht_ctrl
-            end
+          end
         else
           @applicable_fields -= %i(ht_ctrl)
         end