packetgen 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67bab87e209f3ad1ca3adecf77be2b19c1ba17a5
-  data.tar.gz: c5bd835c57160261677a22693e297c8b27ac3cbe
+  metadata.gz: ba692327da7837d4de41a002ca756a778692c74b
+  data.tar.gz: 38fca26934167acbd7d92981f160071c7fd1387f
 SHA512:
-  metadata.gz: 466fadd588084aedad8c7e9fbc7ac6313f8f66d47594171fc7728c2056369ffc2e24fedb4794f4a37cd8fcc66ed4dff7db5339e1f19fefc3522d4906a8667953
-  data.tar.gz: c8bd3cb05a61ae939f152355d45fed6ff0e26b6760dd0bea98fddff4aa86263ec1eea27b24024325ae089246cb78baad3958b9df7a949771150d65c45cba7073
+  metadata.gz: 80d8155ad93876fcb14c5d1d85b3a374a1eb865784b914aed802dbb0ab07e97364d10e5affc2a094f4041f695774a41dd60a65e8da2fbdd92e27ca873ad60ddd
+  data.tar.gz: ac325e1dae38151f1f73ca05b6604a7373060aaee4a814e9d87c98b4de4e8e8aa64ba11f39930693d9cc8f9e4abb028918237d37e99f5a1becabdf93227effe9

data/.travis.yml

@@ -12,7 +12,7 @@ install:
   - bundler install --path vendor/bundle --jobs=3 --retry=3
 before_script:
   - openssl version
-  - gem list openssl
+  - ruby -ropenssl -e 'puts OpenSSL::VERSION'
 script:
   - bundler exec rake
   - rvmsudo bundle exec rake spec:sudo

data/README.md

@@ -131,6 +131,21 @@ pkt = Packet.gen('IP').add('MyHeader', field1: 0x12345678)
 pkt.myheader.field2.read 0x01
 ```
 
+## Interactive console
+PacketGen provides an interactive console, based on `pry`: `pgconsole`.
+
+In this console, context includes PacketGen module to give direct access to PacketGen
+classes. A special `config` object gives local network configuration:
+
+    $ pgconsole
+    pg(main)> config
+    => #<PacketGen::Config:0x00559f27d2afe8
+     @hwaddr="75:74:73:72:71:70",
+     @iface="eth0",
+     @ipaddr="192.168.0.2">
+    pg(main)> packets = capture(max: 5)
+    pg(main)> exit
+
 ## Pull requests?
 
 yes

data/bin/pgconsole

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'packetgen'
+require 'packetgen/config'
+require 'pry'
+
+include PacketGen
+
+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
+
+@config = Config.new
+
+def config
+  @config
+end
+
+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?}* "
+  }
+]
+Pry.config.prompt_name = 'pg'
+Pry.start

data/lib/packetgen/capture.rb

@@ -7,46 +7,83 @@ module PacketGen
 
   # Capture packets from wire
   # @author Sylvain Daubert
+  # @author Kent 'picat' Gruber
   class Capture
 
-    # Default snaplen to use if :snaplen option not defined
+    # Default snaplen to use if :snaplen option not defined.
     DEFAULT_SNAPLEN = 0xffff
 
-    # Get captured packets
+    # Get captured packets.
     # @return [Array<Packets>]
     attr_reader :packets
 
-    # Get captured packet raw data
+    # Get captured packet raw data.
     # @return [Array<String>]
     attr_reader :raw_packets
 
-    # @param [String] iface interface on which capture packets
-    # @param [Hash] options
-    # @option options [Integer] :max maximum number of packets to capture
-    # @option options [Integer] :timeout maximum number of seconds before end
-    #    of capture. Default: +nil+ (no timeout)
-    # @option options [String] :filter bpf filter
-    # @option options [Boolean] :promiscuous (default: +false+)
-    # @option options [Boolean] :parse parse raw data to generate packets before
-    #    yielding.  Default: +true+
-    # @option options [Integer] :snaplen maximum number of bytes to capture for
-    #    each packet
-    def initialize(iface, options={})
-      @packets = []
+    # Get interface name
+    # @return [String]
+    attr_reader :iface
+
+    # @overload initialize(iface=Pcap.lookupdev, options={})
+    #  @param [String] iface interface on which capture packets
+    #  @param [Hash] options
+    #  @option options [Integer] :max maximum number of packets to capture.
+    #  @option options [Integer] :timeout maximum number of seconds before end
+    #     of capture. Default: +nil+ (no timeout)
+    #  @option options [String] :filter bpf filter
+    #  @option options [Boolean] :promiscuous (default: +false+)
+    #  @option options [Boolean] :parse parse raw data to generate packets before
+    #     yielding.  Default: +true+
+    #  @option options [Integer] :snaplen maximum number of bytes to capture for
+    #     each packet.
+    # @overload initialize(options={})
+    #  @param [Hash] options
+    #  @option options [String]  :iface interface on which capture
+    #     packets on. Default: Use default interface lookup. If no interface found,
+    #     use loopback one.
+    #  @option options [Integer] :max maximum number of packets to capture.
+    #  @option options [Integer] :timeout maximum number of seconds before end
+    #     of capture. Default: +nil+ (no timeout)
+    #  @option options [String] :filter bpf filter
+    #  @option options [Boolean] :promiscuous (default: +false+)
+    #  @option options [Boolean] :parse parse raw data to generate packets before
+    #     yielding.  Default: +true+
+    #  @option options [Integer] :snaplen maximum number of bytes to capture for
+    #     each packet.
+    def initialize(iface_or_options={}, options={})
+      begin
+        @iface = Pcap.lookupdev
+      rescue PCAPRUB::BindingError
+        @iface = 'lo'
+      end
+
+      case iface_or_options
+      when Hash
+        options = iface_or_options
+      else
+        warn "[deprecation] use of PacketGen::Capture#initialize with iface name as\n" \
+             "              first argument is deprecated. Instead, use:\n" \
+             '              PacketGen::Capture.new(iface: \'name\').'
+        @iface = iface_or_options.to_s
+      end
+
+      @packets     = []
       @raw_packets = []
-      @iface = iface
+      @promisc = false
+      @snaplen = DEFAULT_SNAPLEN
+      @parse = true
       set_options options
     end
 
     # Start capture
     # @param [Hash] options complete see {#initialize}.
     # @yieldparam [Packet,String] packet if a block is given, yield each
-    #    captured packet (Packet or raw data String, depending on +:parse+)
+    #    captured packet (Packet or raw data String, depending on +:parse+ option)
     def start(options={})
       set_options options
       @pcap = PCAPRUB::Pcap.open_live(@iface, @snaplen, @promisc, 1)
       set_filter
-
       @cap_thread = Thread.new do
         @pcap.each do |packet_data|
           @raw_packets << packet_data
@@ -57,9 +94,7 @@ module PacketGen
           else
             yield packet_data if block_given?
           end
-          if @max
-            break if @raw_packets.size >= @max
-          end
+          break if @max and @raw_packets.size >= @max
         end
       end
       @cap_thread.join(@timeout)
@@ -80,21 +115,10 @@ module PacketGen
       @max = options[:max] if options[:max]
       @filter = options[:filter] if options[:filter]
       @timeout = options[:timeout] if options[:timeout]
-      if options[:promisc]
-        @promisc = options[:promisc]
-      else
-        @promisc ||= false
-      end
-      if options[:snaplen]
-        @snaplen = options[:snaplen]
-      else
-        @snaplen ||= DEFAULT_SNAPLEN
-      end
-      if options[:parse].nil?
-        @parse = true if @parse.nil?
-      else
-        @parse = options[:parse]
-      end
+      @promisc = options[:promisc] if options.has_key? :promisc
+      @snaplen = options[:snaplen] if options[:snaplen]
+      @parse = options[:parse] if options.has_key? :parse
+      @iface = options[:iface] if options[:iface]
     end
 
     def set_filter

data/lib/packetgen/config.rb

@@ -0,0 +1,39 @@
+require 'network_interface'
+require 'socket'
+
+module PacketGen
+
+  # Config class to provide +config+ object to pgconsole
+  # @author Sylvain Daubert
+  class Config
+
+    # 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
+
+    # Create a configuration object. If +iface+ is not set, get first network interface.
+    # If non exists, use loopback one.
+    # @param [String,nil] iface
+    def initialize(iface=nil)
+      if iface.nil?
+        iface = NetworkInterface.interfaces.select { |iface| iface != 'lo' }.first
+        iface = NetworkInterface.interfaces.first if iface.nil?
+      end
+      @iface = iface
+
+      addresses = NetworkInterface.addresses(iface)
+      @hwaddr = addresses[Socket::AF_PACKET][0]['addr'] if addresses[Socket::AF_PACKET]
+      @ipaddr = addresses[Socket::AF_INET][0]['addr'] if addresses[Socket::AF_INET]
+      @ip6addr = addresses[Socket::AF_INET6][0]['addr'] if addresses[Socket::AF_INET6]
+    end
+  end
+end

data/lib/packetgen/packet.rb

@@ -33,10 +33,10 @@ module PacketGen
   #
   # == Get packets
   # Packets may be captured from wire:
-  #  Packet.capture('eth0') do |packet|
+  #  Packet.capture do |packet|
   #    do_some_stuffs
   #  end
-  #  packets = Packet.capture('eth0', max: 5)  # get 5 packets
+  #  packets = Packet.capture(iface: 'eth0', max: 5)  # get 5 packets from eth0
   #
   # Packets may also be read from a file:
   #  packets = Packet.read(file.pcapng)
@@ -68,9 +68,10 @@ module PacketGen
       new.parse binary_str, first_header: first_header
     end
 
-    # Capture packets from +iface+
-    # @param [String] iface interface name
+    # Capture packets
     # @param [Hash] options capture options
+    # @option options [String]  :iface interface on which capture
+    #    packets on. Default: Use default interface lookup.
     # @option options [Integer] :max maximum number of packets to capture
     # @option options [Integer] :timeout maximum number of seconds before end
     #    of capture
@@ -78,8 +79,8 @@ module PacketGen
     # @option options [Boolean] :promiscuous
     # @yieldparam [Packet] packet if a block is given, yield each captured packet
     # @return [Array<Packet>] captured packet
-    def self.capture(iface, options={})
-      capture = Capture.new(iface, options)
+    def self.capture(options={})
+      capture = Capture.new(options)
       if block_given?
         capture.start { |packet| yield packet }
       else

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

data/lib/packetgen.rb

@@ -42,8 +42,8 @@ module PacketGen
   # @param [Hash] options capture options. See {Packet.capture}.
   # @yieldparam [Packet] packet
   # @return [Array<Packet>]
-  def self.capture(iface, options={})
-    Packet.capture(iface, options) { |packet| yield packet if block_given? }
+  def self.capture(options={})
+    Packet.capture(options) { |packet| yield packet if block_given? }
   end
 
   # Shortcut for {Packet.read}

data/packetgen.gemspec

@@ -16,13 +16,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_dependency 'pcaprub', '~>0.12.4'
+  spec.add_dependency 'pry', '~>0.10'
+  spec.add_dependency 'network_interface'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: network_interface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +125,8 @@ dependencies:
 description: 
 email:
 - sylvain.daubert@laposte.net
-executables: []
+executables:
+- pgconsole
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,8 +136,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/pgconsole
 - lib/packetgen.rb
 - lib/packetgen/capture.rb
+- lib/packetgen/config.rb
 - lib/packetgen/header.rb
 - lib/packetgen/header/arp.rb
 - lib/packetgen/header/base.rb