passivedns-client 2.0.4 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f25402e0bd61bb74820cfc984490a96565f33ac5
-  data.tar.gz: dbf4ea9dfe2a501c878bb4c127a4d5bb92e970dd
+  metadata.gz: 9fc3d708ad9c1dd55d73acf19b347589c8142292
+  data.tar.gz: f48765e8140f0f84dd26a8912728190458ab3dbb
 SHA512:
-  metadata.gz: 5ee3a733b4e4518ca18004245a9fc457b8bcc56fde1618545befc534f33d885cb34ef6097784e9e1fe03830df5b96ce9e91cde7b0aeb08f02b0722786fb64b2f
-  data.tar.gz: dcb2ff2f4429fc88dadba5fb269a8a9a72f5df0b6bfb12e53207dff65e2b2e15f61d77f829dd21114a4da2b46389d2f83835185481f4ee1542e327df803094d0
+  metadata.gz: 6c6d15bd3b5e0c556b515512be6645b626139f9c0c2c42c8e48bb7347599edb2bcbb6ca0b011dd8c981a2fdd2d13f50e98f1d34935f81223a60039c237531052
+  data.tar.gz: d14cf8d3a6e50d8e1708d4fa32d11655efec83403ca9ba62fd10c3246dac1b7930d59ace1245a1cd5079270d22fbe7eba3124897b0b6bd95c8518f6346c13e12

data/README.md

@@ -94,7 +94,7 @@ Or use the included tool...
 	  
 	Output Formatting
 	  -g link-nodal GDF visualization definition
-	  -v link-nodal graphviz visualization definition
+	  -z link-nodal graphviz visualization definition
 	  -m link-nodal graphml visualization definition
 	  -c CSV
 	  -x XML

data/lib/passivedns/client/cli.rb

@@ -2,17 +2,30 @@ require 'getoptlong'
 require 'structformatter'
 require 'getoptlong'
 require 'yaml'
+require 'pp'
 
 module PassiveDNS
 	class CLInterface
+    def self.get_letter_map
+      letter_map = {}
+      PassiveDNS.constants.each do |const|
+        if PassiveDNS.const_get(const).is_a?(Class) and PassiveDNS.const_get(const).superclass == PassiveDNS::PassiveDB
+          letter_map[PassiveDNS.const_get(const).option_letter] = [PassiveDNS.const_get(const).name, PassiveDNS.const_get(const).config_section_name]
+        end
+      end
+      letter_map      
+    end
+    
     def self.parse_command_line(args)
+      origARGV = ARGV.dup
+      ARGV.replace(args)
       opts = GetoptLong.new(
       	[ '--help', '-h', GetoptLong::NO_ARGUMENT ],
-      	[ '--debug', '-z', GetoptLong::NO_ARGUMENT ],
+      	[ '--debug', '-v', GetoptLong::NO_ARGUMENT ],
       	[ '--database', '-d', GetoptLong::REQUIRED_ARGUMENT ],
 	
       	[ '--gdf', '-g', GetoptLong::NO_ARGUMENT ],
-      	[ '--graphviz', '-v', GetoptLong::NO_ARGUMENT ],
+      	[ '--graphviz', '-z', GetoptLong::NO_ARGUMENT ],
       	[ '--graphml', '-m', GetoptLong::NO_ARGUMENT ],
       	[ '--csv', '-c', GetoptLong::NO_ARGUMENT ],
       	[ '--xml', '-x', GetoptLong::NO_ARGUMENT ],
@@ -27,12 +40,7 @@ module PassiveDNS
       	[ '--limit', '-l', GetoptLong::REQUIRED_ARGUMENT ]
       )
 
-      letter_map = {}
-      PassiveDNS.constants.each do |const|
-        if PassiveDNS.const_get(const).is_a?(Class) and PassiveDNS.const_get(const).superclass == PassiveDNS::PassiveDB
-          letter_map[PassiveDNS.const_get(const).option_letter] = [PassiveDNS.const_get(const).name, PassiveDNS.const_get(const).config_section_name]
-        end
-      end
+      letter_map = get_letter_map
 
       # sets the default search methods
       options = {
@@ -44,14 +52,14 @@ module PassiveDNS
         :res => nil,
         :debug => false,
         :sqlitedb => nil,
-        :limit => nil
+        :limit => nil,
+        :help => false
       }
 
       opts.each do |opt, arg|
       	case opt
       	when '--help'
-      		puts usage(letter_map)
-          exit
+      		options[:help] = true
       	when '--debug'
       		options[:debug] = true
       	when '--database'
@@ -86,10 +94,6 @@ module PassiveDNS
       		options[:sep] = arg
       	when '--recurse'
       		options[:recursedepth] = arg.to_i
-      		if options[:recursedepth] > 3
-      			$stderr.puts "WARNING:  a recursedepth of > 3 can be abusive, please reconsider: sleeping 60 seconds for sense to come to you (hint: hit CTRL-C)"
-      			sleep 60
-      		end
       	when '--wait'
       		options[:wait] = arg.to_i
       	when '--sqlite3'
@@ -97,10 +101,11 @@ module PassiveDNS
       	when '--limit'
       		options[:limit] = arg.to_i
       	else
-      		puts usage(letter_map)
-          exit
+      		options[:help] = true
       	end
       end
+      args = ARGV.dup
+      ARGV.replace(origARGV)
 
       if options[:pdnsdbs].length == 0
       	options[:pdnsdbs] << "bfk"
@@ -129,9 +134,9 @@ module PassiveDNS
     
     def self.usage(letter_map)
       databases = letter_map.keys.sort.join("")
-      help_text = "\n"
+      help_text = ""
     	help_text << "Usage: #{$0} [-d [#{databases}]] [-g|-v|-m|-c|-x|-y|-j|-t] [-os <sep>] [-f <file>] [-r#|-w#|-v] [-l <count>] <ip|domain|cidr>\n"
-      help_text << "Passive DNS Providers"
+      help_text << "Passive DNS Providers\n"
     	help_text << "  -d#{databases} uses all of the available passive dns database\n"
       letter_map.keys.sort.each do |l|
         help_text << "  -d#{l} use #{letter_map[l][0]}\n"
@@ -140,7 +145,7 @@ module PassiveDNS
     	help_text << "\n"
       help_text << "Output Formatting\n"
     	help_text << "  -g link-nodal GDF visualization definition\n"
-    	help_text << "  -v link-nodal graphviz visualization definition\n"
+    	help_text << "  -z link-nodal graphviz visualization definition\n"
     	help_text << "  -m link-nodal graphml visualization definition\n"
     	help_text << "  -c CSV\n"
     	help_text << "  -x XML\n"
@@ -149,7 +154,7 @@ module PassiveDNS
     	help_text << "  -t ASCII text (default)\n"
     	help_text << "  -s <sep> specifies a field separator for text output, default is tab\n"
     	help_text << "\n"
-      help_text << "State and Recusion\n"
+      help_text << "State and Recursion\n"
     	help_text << "  -f[file] specifies a sqlite3 database used to read the current state - useful for large result sets and generating graphs of previous runs.\n"
     	help_text << "  -r# specifies the levels of recursion to pull. **WARNING** This is quite taxing on the pDNS servers, so use judiciously (never more than 3 or so) or find yourself blocked!\n"
     	help_text << "  -w# specifies the amount of time to wait, in seconds, between queries (Default: 0)\n"
@@ -222,6 +227,13 @@ module PassiveDNS
     
     def self.run(args)
       options, items = parse_command_line(args)
+      if options[:help]
+        return usage(get_letter_map)
+      end
+  		if options[:recursedepth] > 3
+  			$stderr.puts "WARNING:  a recursedepth of > 3 can be abusive, please reconsider: sleeping 60 seconds for sense to come to you (hint: hit CTRL-C)"
+  			sleep 60
+  		end
       state = create_state(options[:sqlitedb])
       state.debug = options[:debug]
 

data/lib/passivedns/client/version.rb

@@ -1,5 +1,5 @@
 module PassiveDNS
   class Client
-    VERSION = "2.0.4"
+    VERSION = "2.0.6"
   end
 end

data/test/test_cli.rb

@@ -0,0 +1,204 @@
+unless Kernel.respond_to?(:require_relative)
+	module Kernel
+		def require_relative(path)
+			require File.join(File.dirname(caller[0]), path.to_str)
+		end
+	end
+end
+
+require_relative 'helper'
+require 'configparser'
+require_relative '../lib/passivedns/client/cli.rb'
+
+class TestCLI < Minitest::Test
+  def test_letter_map
+    letter_map = PassiveDNS::CLI.get_letter_map
+    assert_equal("3bcdmptv", letter_map.keys.sort.join(""))
+  end
+  
+  def test_help_text
+    helptext = PassiveDNS::CLI.run(["--help"])
+    helptext.gsub!(/Usage: .*?\[/, "Usage: [")
+    assert_equal(
+"Usage: [-d [3bcdmptv]] [-g|-v|-m|-c|-x|-y|-j|-t] [-os <sep>] [-f <file>] [-r#|-w#|-v] [-l <count>] <ip|domain|cidr>
+Passive DNS Providers
+  -d3bcdmptv uses all of the available passive dns database
+  -d3 use 360.cn
+  -db use BFK.de
+  -dc use CIRCL
+  -dd use DNSDB
+  -dm use Mnemonic
+  -dp use PassiveTotal
+  -dt use TCPIPUtils
+  -dv use VirusTotal
+  -dvt uses VirusTotal and TCPIPUtils (for example)
+
+Output Formatting
+  -g link-nodal GDF visualization definition
+  -z link-nodal graphviz visualization definition
+  -m link-nodal graphml visualization definition
+  -c CSV
+  -x XML
+  -y YAML
+  -j JSON
+  -t ASCII text (default)
+  -s <sep> specifies a field separator for text output, default is tab
+
+State and Recursion
+  -f[file] specifies a sqlite3 database used to read the current state - useful for large result sets and generating graphs of previous runs.
+  -r# specifies the levels of recursion to pull. **WARNING** This is quite taxing on the pDNS servers, so use judiciously (never more than 3 or so) or find yourself blocked!
+  -w# specifies the amount of time to wait, in seconds, between queries (Default: 0)
+  -l <count> limits the number of records returned per passive dns database queried.
+
+Getting Help
+  -h hello there.  This option produces this helpful help information on how to access help.
+  -v debugging information
+", helptext)
+  end
+  
+  def test_provider_parsing
+    options_target = {
+      :pdnsdbs => ["bfk"],
+      :format => "text",
+      :sep => "\t",
+      :recursedepth => 1,
+      :wait => 0,
+      :res => nil,
+      :debug => false,
+      :sqlitedb => nil,
+      :limit => nil,
+      :help => false
+    }
+    
+    options, items = PassiveDNS::CLI.parse_command_line([])
+    assert_equal(options_target, options)
+    assert_equal([], items)
+    
+    options_target[:pdnsdbs] = ["cn360"]
+    options, items = PassiveDNS::CLI.parse_command_line(["-d3"])
+    assert_equal(options_target, options)
+    assert_equal([], items)
+
+    options_target[:pdnsdbs] = ["bfk"]
+    options, items = PassiveDNS::CLI.parse_command_line(["-db"])
+    assert_equal(options_target, options)
+    assert_equal([], items)
+   
+    options_target[:pdnsdbs] = ["circl", "dnsdb", "mnemonic"]
+    options, items = PassiveDNS::CLI.parse_command_line(["-dcdm"])
+    assert_equal(options_target, options)
+    assert_equal([], items)
+    
+    options_target[:pdnsdbs] = ["passivetotal", "tcpiputils", "virustotal"]
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv"])
+    assert_equal(options_target, options)
+    assert_equal([], items)
+    
+  end
+  
+  def test_output_parsing
+    options_target = {
+      :pdnsdbs => ["passivetotal", "tcpiputils", "virustotal"],
+      :format => "text",
+      :sep => "\t",
+      :recursedepth => 1,
+      :wait => 0,
+      :res => nil,
+      :debug => false,
+      :sqlitedb => nil,
+      :limit => nil,
+      :help => false
+    }
+    
+    options_target[:sep] = ","
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-c", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:sep] = "|"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-s", "|", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:sep] = "\t"
+    
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-t", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+
+    options_target[:format] = "json"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-j", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "xml"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-x", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "yaml"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-y", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "gdf"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-g", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "graphviz"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-z", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "graphml"
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-m", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:format] = "text"
+  end
+  
+  def test_help_debug_parsing
+    options_target = {
+      :pdnsdbs => ["passivetotal", "tcpiputils", "virustotal"],
+      :format => "text",
+      :sep => "\t",
+      :recursedepth => 1,
+      :wait => 0,
+      :res => nil,
+      :debug => false,
+      :sqlitedb => nil,
+      :limit => nil,
+      :help => true
+    }
+
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-h", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+    
+    options_target[:debug] = true
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-h", "-v", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+  end
+  
+  def test_state_recursion_parsing
+    options_target = {
+      :pdnsdbs => ["passivetotal", "tcpiputils", "virustotal"],
+      :format => "text",
+      :sep => "\t",
+      :recursedepth => 5,
+      :wait => 30,
+      :res => nil,
+      :debug => false,
+      :sqlitedb => "test.db",
+      :limit => 10,
+      :help => false
+    }
+
+    options, items = PassiveDNS::CLI.parse_command_line(["-dptv", "-f", "test.db", "-r", "5", "-w", "30", "-l", "10", "8.8.8.8"])
+    assert_equal(options_target, options)
+    assert_equal(["8.8.8.8"], items)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passivedns-client
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.6
 platform: ruby
 authors:
 - chrislee35
@@ -139,6 +139,7 @@ files:
 - lib/passivedns/client/version.rb
 - passivedns-client.gemspec
 - test/helper.rb
+- test/test_cli.rb
 - test/test_passivedns-client.rb
 homepage: https://github.com/chrislee35/passivedns-client
 licenses:
@@ -166,4 +167,5 @@ specification_version: 4
 summary: Query passive DNS databases
 test_files:
 - test/helper.rb
+- test/test_cli.rb
 - test/test_passivedns-client.rb