Class: PassiveDNS::CLInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/passivedns/client/cli.rb

Class Method Summary collapse

Class Method Details

.create_state(sqlitedb = nil) ⇒ Object 



213
214
215
216
217
218
219
220
 
# File 'lib/passivedns/client/cli.rb', line 213

def self.create_state(sqlitedb=nil)
  state = nil
  if sqlitedb
  	state = PassiveDNS::PDNSToolStateDB.new(sqlitedb)
  else
  	state = PassiveDNS::PDNSToolState.new
  end
end

.parse_command_line(args) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/passivedns/client/cli.rb', line 8

def self.parse_command_line(args)
  opts = GetoptLong.new(
  	[ '--help', '-h', GetoptLong::NO_ARGUMENT ],
  	[ '--debug', '-z', GetoptLong::NO_ARGUMENT ],
  	[ '--database', '-d', GetoptLong::REQUIRED_ARGUMENT ],
	
  	[ '--gdf', '-g', GetoptLong::NO_ARGUMENT ],
  	[ '--graphviz', '-v', GetoptLong::NO_ARGUMENT ],
  	[ '--graphml', '-m', GetoptLong::NO_ARGUMENT ],
  	[ '--csv', '-c', GetoptLong::NO_ARGUMENT ],
  	[ '--xml', '-x', GetoptLong::NO_ARGUMENT ],
  	[ '--yaml', '-y', GetoptLong::NO_ARGUMENT ],
  	[ '--json', '-j', GetoptLong::NO_ARGUMENT ],
  	[ '--text', '-t', GetoptLong::NO_ARGUMENT ],
  	[ '--sep', '-s', GetoptLong::REQUIRED_ARGUMENT ],
	
  	[ '--sqlite3', '-f', GetoptLong::REQUIRED_ARGUMENT ],
  	[ '--recurse', '-r', GetoptLong::REQUIRED_ARGUMENT ],
  	[ '--wait', '-w', GetoptLong::REQUIRED_ARGUMENT ],
  	[ '--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

  # sets the default search methods
  options = {
    :pdnsdbs => [],
    :format => "text",
    :sep => "\t",
    :recursedepth => 1,
    :wait => 0,
    :res => nil,
    :debug => false,
    :sqlitedb => nil,
    :limit => nil
  }

  opts.each do |opt, arg|
  	case opt
  	when '--help'
  		puts usage(letter_map)
      exit
  	when '--debug'
  		options[:debug] = true
  	when '--database'
    	arg.split(//).each do |c|
        if c == ','
          next
        elsif letter_map[c]
          options[:pdnsdbs] << letter_map[c][1]
        else
          $stderr.puts "ERROR: Unknown passive DNS database identifier: #{c}."
          usage(letter_map)
        end
      end
  	when '--gdf'
  		options[:format] = 'gdf'
  	when '--graphviz'
  		options[:format] = 'graphviz'
  	when '--graphml'
  		options[:format] = 'graphml'
  	when '--csv'
  		options[:format] = 'text'
  		options[:sep] = ','
  	when '--yaml'
  		options[:format] = 'yaml'
  	when '--xml'
  		options[:format] = 'xml'
  	when '--json'
  		options[:format] = 'json'
  	when '--text'
  		options[:format] = 'text'
  	when '--sep'
  		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'
  		options[:sqlitedb] = arg
  	when '--limit'
  		otions[:limit] = arg.to_i
  	else
  		puts usage(letter_map)
      exit
  	end
  end

  if options[:pdnsdbs].length == 0
  	options[:pdnsdbs] << "bfk"
  end

  if options[:pdnsdbs].index("bfk") and recursedepth > 1 and wait < 60
  	options[:wait] = 60
  	$stderr.puts "Enforcing a minimal 60 second wait when using BFK for recursive crawling"
  end

  if options[:debug]
  	$stderr.puts "Using the following databases: #{options[:pdnsdbs].join(", ")}"
  	$stderr.puts "Recursions: #{options[:recursedepth]}, Wait time: #{options[:wait]}, Limit: #{options[:limit] or 'none'}"
  	if options[:format] == "text" or options[:format] == "csv"
      	$stderr.puts "Output format: #{options[:format]} (sep=\"#{options[:sep]}\")"
  	else
      	$stderr.puts "Output format: #{options[:format]}"
  	end
  	if ENV['http_proxy']
  		$stderr.puts "Using proxy settings: http_proxy=#{ENV['http_proxy']}, https_proxy=#{ENV['https_proxy']}"
  	end
  end
  
  [options, args]
end

.pdnslookup(state, pdnsclient, options) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/passivedns/client/cli.rb', line 164

def self.pdnslookup(state, pdnsclient, options)
  recursedepth = options[:recursedepth]
  wait = options[:wait]
  debug = options[:debug]
  limit = options[:limit]
	puts "pdnslookup: #{state.level} #{recursedepth}" if debug
	level = 0
	while level < recursedepth
		puts "pdnslookup: #{level} < #{recursedepth}" if debug
		state.each_query(recursedepth) do |q|
			rv = pdnsclient.query(q,limit)
			if rv
				rv.each do |r|
					if ["A","AAAA","NS","CNAME","PTR"].index(r.rrtype)
						puts "pdnslookup: #{r.to_s}" if debug
						state.add_result(r)
					end
				end
			else
				state.update_query(rv,'failed')
			end
			sleep wait if level < recursedepth
		end
		level += 1
	end
	state
end

.results_to_s(state, options) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/passivedns/client/cli.rb', line 192

def self.results_to_s(state,options)
  format = options[:format]
  sep = options[:sep]
	case format
	when 'text'
		PassiveDNS::PDNSResult.members.join(sep)+"\n"+state.to_s(sep)
	when 'yaml'
		state.to_yaml
	when 'xml'
		state.to_xml
	when 'json'
		state.to_json
	when 'gdf'
		state.to_gdf
	when 'graphviz'
		state.to_graphviz
	when 'graphml'
		state.to_graphml
	end
end

.run(args) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/passivedns/client/cli.rb', line 222

def self.run(args)
  options, items = parse_command_line(args)
  state = create_state(options[:sqlitedb])
  state.debug = options[:debug]

  pdnsclient = PassiveDNS::Client.new(options[:pdnsdbs])
  pdnsclient.debug = options[:debug]
  
  if ARGV.length > 0
  	ARGV.each do |arg|
  		state.add_query(arg,'pending',0)
  	end
  else
  	$stdin.each_line do |l|
  		state.add_query(l.chomp,'pending',0)
  	end
  end
  pdnslookup(state,pdnsclient,options)
  results_to_s(state,options)
end

.usage(letter_map) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/passivedns/client/cli.rb', line 130

def self.usage(letter_map)
  databases = letter_map.keys.sort.join("")
  help_text = "\n"
	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 << "  -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"
  end
	help_text << "  -dvt uses VirusTotal and TCPIPUtils (for example)\n"
	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 << "  -m link-nodal graphml visualization definition\n"
	help_text << "  -c CSV\n"
	help_text << "  -x XML\n"
	help_text << "  -y YAML\n"
	help_text << "  -j JSON\n"
	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 << "  -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"
	help_text << "  -l <count> limits the number of records returned per passive dns database queried.\n"
	help_text << "\n"
  help_text << "Getting Help\n"
	help_text << "  -v debugging information\n"
  
	help_text
end