packetman 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3819b6864ab2d131bcd29e65c79a02123a1d4b4
-  data.tar.gz: 7de18ca9f2f368755393dbc6c0d3b4edfb34a019
+  metadata.gz: a30c3ba57b035cf5927580b722a5651aefc55317
+  data.tar.gz: 68c4aa0507610985b538da8e6b8b432ffbd6aa49
 SHA512:
-  metadata.gz: f70eb13025b20f23690c6d0b169bb165a7ea035597bd863a5bb1279711eb1f40f54fe393e0611715b980f460e5d899f2ddf92a8ce2806544d70f26d3cf0599e8
-  data.tar.gz: 3f2df4b4ee6be9f721195aa661b8ae91bf7aeccd77c8935fa6b51464c872e345206c103af7898342f102ddc55859ddb300642a5420b1e7831b24585f3b378dcb
+  metadata.gz: 976a934d36e13ceb1593728d7067198bbbe78d036da0a600ffa58703483709ca35c813feb3198aa3575ed9f6c9ca680a96572c31a05358ee542438c5d248fec3
+  data.tar.gz: 727bf261f5a87940af9abd8e636272dce8d1e2de7746976b2079b2b6dff2717da849fbd780b0da17df47ee2fed1a981f48ae0e7ce7cdb52ad7e61cd532f8354f

data/README.md

@@ -2,7 +2,11 @@
 
 Advanced tcpdump and Wireshark capture generator.
 
-[![Gem Version](https://badge.fury.io/rb/packetman.svg)](http://badge.fury.io/rb/packetman) [![Code Climate](https://codeclimate.com/github/jescholl/packetman/badges/gpa.svg)](https://codeclimate.com/github/jescholl/packetman) [![Test Coverage](https://codeclimate.com/github/jescholl/packetman/badges/coverage.svg)](https://codeclimate.com/github/jescholl/packetman/coverage) [![Circle CI](https://circleci.com/gh/jescholl/packetman.svg?style=svg)](https://circleci.com/gh/jescholl/packetman)
+[![Gem Version](https://badge.fury.io/rb/packetman.svg)](http://badge.fury.io/rb/packetman)
+[![Test Coverage](https://codeclimate.com/github/jescholl/packetman/badges/coverage.svg)](https://codeclimate.com/github/jescholl/packetman/coverage)
+[![Inline docs](http://inch-ci.org/github/jescholl/packetman.svg?branch=master)](http://inch-ci.org/github/jescholl/packetman)
+[![Circle CI](https://circleci.com/gh/jescholl/packetman.svg?style=svg)](https://circleci.com/gh/jescholl/packetman)
+[![Code Climate](https://codeclimate.com/github/jescholl/packetman/badges/gpa.svg)](https://codeclimate.com/github/jescholl/packetman)
 
 Packetman is a packet capture filter generator modeled after [Wireshark's String-Matching Capture Filter Generator](https://www.wireshark.org/tools/string-cf.html) but with a lot more features allowing much finer control over the packets you see.
 

data/exe/packetman

@@ -3,4 +3,4 @@ require 'packetman'
 
 search_str = Packetman.config.parse_opts
 
-puts Packetman::Compose.new(search_str)
+puts Packetman::Filter.new(search_str)

data/lib/packetman.rb

@@ -3,7 +3,8 @@ require "packetman/version"
 require "packetman/config"
 require "packetman/config_methods"
 require "packetman/table"
-require "packetman/compose"
+require "packetman/filter"
+require "packetman/clause"
 
 module Packetman
   class << self
@@ -15,5 +16,6 @@ module Packetman
     def config!
       @config = Config.new
     end
+
   end
 end

data/lib/packetman/clause.rb

@@ -0,0 +1,26 @@
+module Packetman
+  class Clause
+    include ConfigMethods
+
+    attr_accessor :search, :mask, :offset
+
+    def initialize(search, mask, offset)
+      self.search = search
+      self.mask = mask
+      self.offset = offset
+    end
+
+    def start_byte(start_bit)
+      "#{config.payload_query} + #{(config.offset_bits + start_bit)/8}"
+    end
+
+    def data_address(start_bit, data_bits)
+      "#{config.transport}[#{start_byte(start_bit)}:#{data_bits/8}]"
+    end
+
+    def to_s
+      "#{data_address(offset, Filter.bit_length(search))} & #{mask} = #{search}"
+    end
+
+  end
+end

data/lib/packetman/config.rb

@@ -2,8 +2,7 @@ require 'optparse'
 
 module Packetman
   class Config
-    attr_accessor :transport, :application, :use_bytes, :allow_wildcards, :radix, :start_with_transport
-    attr_writer :offset
+    attr_accessor :transport, :application, :use_bytes, :radix, :start_with_transport, :offset, :wildcard
 
     def initialize
       @transport = "tcp"
@@ -18,31 +17,33 @@ module Packetman
       protocols[transport]['payload_query'] unless start_with_transport
     end
 
-    def offset
+    def offset_bits
       if use_bytes
-        @offset*8
+        offset*8
       else
-        @offset
+        offset
       end
     end
 
-    def parse_opts
+    def opts
       @opts ||= OptionParser.new do |opt|
         opt.banner = "Usage: #{File.basename($PROGRAM_NAME)} [OPTIONS] FILTER_STRING"
-        opt.on("-p", "--protocol [PROTO]", protocols.keys, "Transport Protocol (#{protocols.keys.join(',')})") {|v| self.transport = v }
+        opt.on("-p", "--protocol PROTO", protocols.keys, "Transport Protocol ( #{protocols.keys.join(',')})") { |v| self.transport = v }
         opt.on("-t", "--transport", "OFFSET starts at transport header instead of data payload") { |v| self.start_with_transport = v }
-        opt.on("-r", "--radix [RADIX]", Integer, "Treat FILTER_STRING as RADIX instead of String") {|v| self.radix = v; }
-        opt.on("-o", "--offset [OFFSET]", Integer, "Offset in bits") {|v| self.offset = v; }
+        opt.on("-r", "--radix RADIX", Integer, "Treat FILTER_STRING as RADIX instead of String") { |v| self.radix = v }
+        opt.on("-o", "--offset OFFSET", Integer, "Offset in bits") { |v| self.offset = v }
         opt.on("-b", "--byte-offset", "Use 8-bit bytes instead of bits for offset") { |v| self.use_bytes = v }
-        opt.on("-w", "--wildcards", "Allow '?' wildcards") { |v| self.allow_wildcards = v }
+        opt.on("-w", "--wildcard [CHARACTER=?]", "Treat CHARACTER as single-character wildcard") { |v| raise "invalid wildcard" if v.to_s.length > 1; self.wildcard = v || '?' }
         opt.on("-v", "--version", "Show version") { puts Packetman::VERSION; exit }
       end
+    end
 
-      @opts.parse!
-
-      raise "Invalid command line arguments" if ARGV.size != 1
 
-      ARGV.pop
+    def parse_opts
+      filter_str = ARGV.pop
+      raise "Invalid command line arguments" unless filter_str
+      opts.parse!
+      filter_str
     end
 
   end

data/lib/packetman/filter.rb

@@ -0,0 +1,89 @@
+module Packetman
+  class Filter
+    include ConfigMethods
+
+    attr_accessor :input
+
+    def initialize(input)
+      self.input = input
+      yield config if block_given?
+    end
+
+    def self.bit_length(num)
+      case num
+      when /^0x/
+        $'.length * bit_density(16)
+      when /^0b/
+        $'.length * bit_density(2)
+      else
+        nil
+      end
+    end
+
+    def self.bit_density(radix=config.radix)
+      (radix.nil?) ? 8 : Math.log2(radix).to_i
+    end
+
+    def map_chr
+      pad_right(input.scan(/./).map{ |chr| yield chr }.join)
+    end
+
+    def pad_right(bin_str)
+      bin_str.ljust(desired_length, '0')
+    end
+
+    def desired_length
+      ((input.length + config.offset_bits)/8.to_f).ceil*8 - config.offset_bits
+    end
+
+    def radix_mask
+      ("1"*self.class.bit_density).to_i(2)
+    end
+
+    def mask_chr(chr)
+      if chr == config.wildcard
+        0
+      else
+        radix_mask
+      end.to_s(2).rjust(self.class.bit_density, '0')
+    end
+
+    def bin_chr(chr)
+      chr = '0' if chr == config.wildcard
+
+      if config.radix
+        raise "invalid character '#{chr}' for radix=#{config.radix}" if chr.downcase != chr.to_i(config.radix).to_s(config.radix).downcase
+        chr.to_i(config.radix)
+      else
+        chr.ord
+      end.to_s(2).rjust(self.class.bit_density, '0')
+    end
+
+    def mask_hex
+      hex_encode(map_chr{ |c| mask_chr(c) })
+    end
+
+    def search_hex
+      hex_encode(map_chr{ |c| bin_chr(c) })
+    end
+
+    def hex_encode(bin_str)
+      bin_str.reverse.scan(/.{1,4}/).map{ |chunk|
+        chunk.reverse.to_i(2).to_s(16)
+      }.reverse.join.scan(/.{8}|.{4}|.{2}/).map{ |hex|
+        hex.prepend('0x')
+      }
+    end
+
+    def to_s
+      offset = 0
+      [].tap do |filter|
+        search_hex.zip(mask_hex).each do |search, mask|
+          filter << Packetman::Clause.new(search, mask, offset)
+          offset += self.class.bit_length(search)
+        end
+      end.map{ |b| b.to_s }.join(' && ')
+    end
+
+  end
+end

data/lib/packetman/version.rb

@@ -1,3 +1,3 @@
 module Packetman
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetman
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jason Scholl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,9 +104,10 @@ files:
 - config/protocols.yml
 - exe/packetman
 - lib/packetman.rb
-- lib/packetman/compose.rb
+- lib/packetman/clause.rb
 - lib/packetman/config.rb
 - lib/packetman/config_methods.rb
+- lib/packetman/filter.rb
 - lib/packetman/table.rb
 - lib/packetman/version.rb
 - packetman.gemspec

data/lib/packetman/compose.rb

@@ -1,93 +0,0 @@
-module Packetman
-  class Compose
-    include ConfigMethods
-
-    def initialize(input, radix=config.radix)
-      @input = input
-      @radix = radix
-    end
-
-    def desired_length
-      ((@input.length + config.offset)/8.to_f).ceil*8 - config.offset
-    end
-
-    def bit_density(radix=@radix)
-      (radix.nil?) ? 8 : Math.log2(radix).to_i
-    end
-
-    def mask_bits
-      shift(@input.scan(/./).map{ |c| mask_chr(c) }.join)
-    end
-
-    def radix_mask
-      ("1"*bit_density).to_i(2)
-    end
-
-    def shift(input)
-      input.ljust(desired_length, '0')
-    end
-
-    def search_bits
-      shift(@input.scan(/./).map{ |c| bin_chr(c) }.join)
-    end
-
-    def mask_chr(chr)
-      if chr == '?'
-        raise "wildcards not allowed" unless config.allow_wildcards
-        0
-      else
-        radix_mask
-      end.to_s(2).rjust(bit_density, '0')
-    end
-
-    def bin_chr(chr)
-      if chr == '?'
-        raise "wildcards not allowed" unless config.allow_wildcards
-        chr = '0'
-      end
-
-      if @radix
-        chr.to_i(@radix)
-      else
-        chr.ord
-      end.to_s(2).rjust(bit_density, '0')
-    end
-
-    def mask_hex
-      hex_encode(mask_bits)
-    end
-
-    def search_hex
-      hex_encode(search_bits)
-    end
-
-    def hex_encode(bin_str)
-      bin_str.reverse.scan(/.{1,4}/).map{ |chunk| chunk.reverse.to_i(2).to_s(16) }.reverse.join.scan(/.{8}|.{4}|.{2}/).map{ |hex| hex.prepend('0x') }
-    end
-
-    def bit_length(num)
-      case num
-      when /^0x/
-        $'.length * bit_density(16)
-      when /^0b/
-        $'.length * bit_density(2)
-      else
-        nil
-      end
-    end
-
-    def start_byte(bit_position)
-      [config.payload_query, (config.offset + bit_position)/8].compact.join(' + ')
-    end
-
-    def data_address(start_bit, bit_length)
-      "#{config.transport}[#{start_byte(start_bit)}:#{bit_length/8}]"
-    end
-
-    def to_s
-      search_hex.zip(mask_hex).map.with_index do |(search, mask),i|
-        "#{data_address(i*32, bit_length(search))} & #{mask} = #{search}"
-      end.join(' && ')
-    end
-  end
-end