firescan 0.07

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. data/LICENSE.txt +202 -0
  2. data/README.txt +37 -0
  3. data/USAGE.txt +43 -0
  4. data/VERSION.txt +4 -0
  5. data/bin/firescan +4 -0
  6. data/build +7 -0
  7. data/doc/Example.html +224 -0
  8. data/doc/Firebind.html +213 -0
  9. data/doc/Firebind/Client.html +750 -0
  10. data/doc/Firebind/Portspec.html +390 -0
  11. data/doc/Firebind/Scan.html +413 -0
  12. data/doc/Firebind/ScanError.html +277 -0
  13. data/doc/Firebind/ScanState.html +1015 -0
  14. data/doc/Firebind/SimpleProtocol.html +292 -0
  15. data/doc/Firebind/TcpTransport.html +481 -0
  16. data/doc/Firebind/Transport.html +275 -0
  17. data/doc/Firebind/UdpTransport.html +472 -0
  18. data/doc/LICENSE_txt.html +323 -0
  19. data/doc/README_txt.html +171 -0
  20. data/doc/Runner.html +166 -0
  21. data/doc/TestPortspec.html +289 -0
  22. data/doc/Tools.html +321 -0
  23. data/doc/USAGE_txt.html +184 -0
  24. data/doc/VERSION_txt.html +126 -0
  25. data/doc/build.html +125 -0
  26. data/doc/created.rid +22 -0
  27. data/doc/doc/created_rid.html +121 -0
  28. data/doc/firescan_gemspec.html +140 -0
  29. data/doc/images/add.png +0 -0
  30. data/doc/images/arrow_up.png +0 -0
  31. data/doc/images/brick.png +0 -0
  32. data/doc/images/brick_link.png +0 -0
  33. data/doc/images/bug.png +0 -0
  34. data/doc/images/bullet_black.png +0 -0
  35. data/doc/images/bullet_toggle_minus.png +0 -0
  36. data/doc/images/bullet_toggle_plus.png +0 -0
  37. data/doc/images/date.png +0 -0
  38. data/doc/images/delete.png +0 -0
  39. data/doc/images/find.png +0 -0
  40. data/doc/images/loadingAnimation.gif +0 -0
  41. data/doc/images/macFFBgHack.png +0 -0
  42. data/doc/images/package.png +0 -0
  43. data/doc/images/page_green.png +0 -0
  44. data/doc/images/page_white_text.png +0 -0
  45. data/doc/images/page_white_width.png +0 -0
  46. data/doc/images/plugin.png +0 -0
  47. data/doc/images/ruby.png +0 -0
  48. data/doc/images/tag_blue.png +0 -0
  49. data/doc/images/tag_green.png +0 -0
  50. data/doc/images/transparent.png +0 -0
  51. data/doc/images/wrench.png +0 -0
  52. data/doc/images/wrench_orange.png +0 -0
  53. data/doc/images/zoom.png +0 -0
  54. data/doc/index.html +118 -0
  55. data/doc/js/darkfish.js +155 -0
  56. data/doc/js/jquery.js +18 -0
  57. data/doc/js/navigation.js +142 -0
  58. data/doc/js/search.js +94 -0
  59. data/doc/js/search_index.js +1 -0
  60. data/doc/js/searcher.js +228 -0
  61. data/doc/rdoc.css +595 -0
  62. data/doc/table_of_contents.html +230 -0
  63. data/firescan.gemspec +18 -0
  64. data/lib/example.rb +20 -0
  65. data/lib/firebind/client.rb +308 -0
  66. data/lib/firebind/portspec.rb +107 -0
  67. data/lib/firebind/scan.rb +288 -0
  68. data/lib/firebind/scan_error.rb +32 -0
  69. data/lib/firebind/scan_state.rb +140 -0
  70. data/lib/firebind/simple_protocol.rb +59 -0
  71. data/lib/firebind/tcp_transport.rb +184 -0
  72. data/lib/firebind/tools.rb +107 -0
  73. data/lib/firebind/transport.rb +44 -0
  74. data/lib/firebind/udp_transport.rb +174 -0
  75. data/test/portspec_test.rb +53 -0
  76. data/test/runner.rb +7 -0
  77. metadata +136 -0
@@ -0,0 +1,321 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>module Tools - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="module">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
28
+ <a href="./table_of_contents.html#classes">Classes</a>
29
+ <a href="./table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/firebind/tools.rb
53
+ </ul>
54
+ </nav>
55
+
56
+
57
+ </div>
58
+
59
+ <div id="class-metadata">
60
+
61
+
62
+
63
+
64
+ <!-- Method Quickref -->
65
+ <nav id="method-list-section" class="section">
66
+ <h3 class="section-header">Methods</h3>
67
+
68
+ <ul class="link-list">
69
+
70
+ <li ><a href="#method-i-big_endian">#big_endian</a>
71
+
72
+ <li ><a href="#method-i-debug">#debug</a>
73
+
74
+ <li ><a href="#method-i-out">#out</a>
75
+
76
+ <li ><a href="#method-i-verbose">#verbose</a>
77
+
78
+ </ul>
79
+ </nav>
80
+
81
+ </div>
82
+
83
+ <div id="project-metadata">
84
+ <nav id="fileindex-section" class="section project-section">
85
+ <h3 class="section-header">Pages</h3>
86
+
87
+ <ul>
88
+
89
+ <li class="file"><a href="./LICENSE_txt.html">LICENSE</a>
90
+
91
+ <li class="file"><a href="./README_txt.html">README</a>
92
+
93
+ <li class="file"><a href="./USAGE_txt.html">USAGE</a>
94
+
95
+ <li class="file"><a href="./VERSION_txt.html">VERSION</a>
96
+
97
+ <li class="file"><a href="./build.html">build</a>
98
+
99
+ <li class="file"><a href="./doc/created_rid.html">created.rid</a>
100
+
101
+ <li class="file"><a href="./firescan_gemspec.html">firescan.gemspec</a>
102
+
103
+ </ul>
104
+ </nav>
105
+
106
+ <nav id="classindex-section" class="section project-section">
107
+ <h3 class="section-header">Class and Module Index</h3>
108
+
109
+ <ul class="link-list">
110
+
111
+ <li><a href="./Example.html">Example</a>
112
+
113
+ <li><a href="./Firebind.html">Firebind</a>
114
+
115
+ <li><a href="./Firebind/Client.html">Firebind::Client</a>
116
+
117
+ <li><a href="./Firebind/Portspec.html">Firebind::Portspec</a>
118
+
119
+ <li><a href="./Firebind/Scan.html">Firebind::Scan</a>
120
+
121
+ <li><a href="./Firebind/ScanError.html">Firebind::ScanError</a>
122
+
123
+ <li><a href="./Firebind/ScanState.html">Firebind::ScanState</a>
124
+
125
+ <li><a href="./Firebind/SimpleProtocol.html">Firebind::SimpleProtocol</a>
126
+
127
+ <li><a href="./Firebind/TcpTransport.html">Firebind::TcpTransport</a>
128
+
129
+ <li><a href="./Firebind/Transport.html">Firebind::Transport</a>
130
+
131
+ <li><a href="./Firebind/UdpTransport.html">Firebind::UdpTransport</a>
132
+
133
+ <li><a href="./Runner.html">Runner</a>
134
+
135
+ <li><a href="./TestPortspec.html">TestPortspec</a>
136
+
137
+ <li><a href="./Tools.html">Tools</a>
138
+
139
+ </ul>
140
+ </nav>
141
+
142
+ </div>
143
+ </nav>
144
+
145
+ <div id="documentation">
146
+ <h1 class="module">module Tools</h1>
147
+
148
+ <div id="description" class="description">
149
+
150
+ <p>Utility module for translating socket and result codes.</p>
151
+
152
+ </div><!-- description -->
153
+
154
+
155
+
156
+
157
+ <section id="5Buntitled-5D" class="documentation-section">
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <!-- Methods -->
167
+
168
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
169
+ <h3 class="section-header">Public Instance Methods</h3>
170
+
171
+
172
+ <div id="method-i-big_endian" class="method-detail ">
173
+
174
+ <div class="method-heading">
175
+ <span class="method-name">big_endian</span><span
176
+ class="method-args">(a_number)</span>
177
+
178
+ <span class="method-click-advice">click to toggle source</span>
179
+
180
+ </div>
181
+
182
+
183
+ <div class="method-description">
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <div class="method-source-code" id="big_endian-source">
191
+ <pre><span class="ruby-comment"># File lib/firebind/tools.rb, line 23</span>
192
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">big_endian</span>(<span class="ruby-identifier">a_number</span>)
193
+ <span class="ruby-identifier">bytes</span> = []
194
+ <span class="ruby-value">7</span>.<span class="ruby-identifier">downto</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
195
+ <span class="ruby-identifier">bytes</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-value">0xFF</span> <span class="ruby-operator">&amp;</span> <span class="ruby-identifier">a_number</span>
196
+ <span class="ruby-identifier">a_number</span> = <span class="ruby-identifier">a_number</span> <span class="ruby-operator">&gt;&gt;</span> <span class="ruby-value">8</span>
197
+ <span class="ruby-keyword">end</span>
198
+ <span class="ruby-identifier">bytes</span>
199
+ <span class="ruby-keyword">end</span></pre>
200
+ </div><!-- big_endian-source -->
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+ </div><!-- big_endian-method -->
208
+
209
+
210
+ <div id="method-i-debug" class="method-detail ">
211
+
212
+ <div class="method-heading">
213
+ <span class="method-name">debug</span><span
214
+ class="method-args">(msg)</span>
215
+
216
+ <span class="method-click-advice">click to toggle source</span>
217
+
218
+ </div>
219
+
220
+
221
+ <div class="method-description">
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <div class="method-source-code" id="debug-source">
229
+ <pre><span class="ruby-comment"># File lib/firebind/tools.rb, line 99</span>
230
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
231
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;DEBUG #{self.class.to_s} - #{msg}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$debug</span>
232
+ <span class="ruby-keyword">end</span></pre>
233
+ </div><!-- debug-source -->
234
+
235
+ </div>
236
+
237
+
238
+
239
+
240
+ </div><!-- debug-method -->
241
+
242
+
243
+ <div id="method-i-out" class="method-detail ">
244
+
245
+ <div class="method-heading">
246
+ <span class="method-name">out</span><span
247
+ class="method-args">(msg)</span>
248
+
249
+ <span class="method-click-advice">click to toggle source</span>
250
+
251
+ </div>
252
+
253
+
254
+ <div class="method-description">
255
+
256
+
257
+
258
+
259
+
260
+
261
+ <div class="method-source-code" id="out-source">
262
+ <pre><span class="ruby-comment"># File lib/firebind/tools.rb, line 103</span>
263
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">out</span>(<span class="ruby-identifier">msg</span>)
264
+ <span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span>
265
+ <span class="ruby-keyword">end</span></pre>
266
+ </div><!-- out-source -->
267
+
268
+ </div>
269
+
270
+
271
+
272
+
273
+ </div><!-- out-method -->
274
+
275
+
276
+ <div id="method-i-verbose" class="method-detail ">
277
+
278
+ <div class="method-heading">
279
+ <span class="method-name">verbose</span><span
280
+ class="method-args">(msg)</span>
281
+
282
+ <span class="method-click-advice">click to toggle source</span>
283
+
284
+ </div>
285
+
286
+
287
+ <div class="method-description">
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <div class="method-source-code" id="verbose-source">
295
+ <pre><span class="ruby-comment"># File lib/firebind/tools.rb, line 95</span>
296
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">verbose</span>(<span class="ruby-identifier">msg</span>)
297
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Firescan - #{msg}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$verbose</span>
298
+ <span class="ruby-keyword">end</span></pre>
299
+ </div><!-- verbose-source -->
300
+
301
+ </div>
302
+
303
+
304
+
305
+
306
+ </div><!-- verbose-method -->
307
+
308
+
309
+ </section><!-- public-instance-method-details -->
310
+
311
+ </section><!-- 5Buntitled-5D -->
312
+
313
+ </div><!-- documentation -->
314
+
315
+
316
+ <footer id="validator-badges">
317
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
318
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
319
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
320
+ </footer>
321
+
@@ -0,0 +1,184 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>USAGE - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body class="file">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
28
+ <a href="./table_of_contents.html#classes">Classes</a>
29
+ <a href="./table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+ <div id="table-of-contents">
48
+ <nav class="section">
49
+ <h3 class="section-header">Table of Contents</h3>
50
+ <ul>
51
+ <li><a href="#label-Synopsis">Synopsis</a>
52
+ <li><a href="#label-Examples">Examples</a>
53
+ <li><a href="#label-Usage">Usage</a>
54
+ <li><a href="#label-Options">Options</a>
55
+ <li><a href="#label-Author">Author</a>
56
+ <li><a href="#label-Copyright">Copyright</a>
57
+ </ul>
58
+ </nav>
59
+ </div>
60
+
61
+
62
+ <div id="project-metadata">
63
+ <nav id="fileindex-section" class="section project-section">
64
+ <h3 class="section-header">Pages</h3>
65
+
66
+ <ul>
67
+
68
+ <li class="file"><a href="./LICENSE_txt.html">LICENSE</a>
69
+
70
+ <li class="file"><a href="./README_txt.html">README</a>
71
+
72
+ <li class="file"><a href="./USAGE_txt.html">USAGE</a>
73
+
74
+ <li class="file"><a href="./VERSION_txt.html">VERSION</a>
75
+
76
+ <li class="file"><a href="./build.html">build</a>
77
+
78
+ <li class="file"><a href="./doc/created_rid.html">created.rid</a>
79
+
80
+ <li class="file"><a href="./firescan_gemspec.html">firescan.gemspec</a>
81
+
82
+ </ul>
83
+ </nav>
84
+
85
+ <nav id="classindex-section" class="section project-section">
86
+ <h3 class="section-header">Class and Module Index</h3>
87
+
88
+ <ul class="link-list">
89
+
90
+ <li><a href="./Example.html">Example</a>
91
+
92
+ <li><a href="./Firebind.html">Firebind</a>
93
+
94
+ <li><a href="./Firebind/Client.html">Firebind::Client</a>
95
+
96
+ <li><a href="./Firebind/Portspec.html">Firebind::Portspec</a>
97
+
98
+ <li><a href="./Firebind/Scan.html">Firebind::Scan</a>
99
+
100
+ <li><a href="./Firebind/ScanError.html">Firebind::ScanError</a>
101
+
102
+ <li><a href="./Firebind/ScanState.html">Firebind::ScanState</a>
103
+
104
+ <li><a href="./Firebind/SimpleProtocol.html">Firebind::SimpleProtocol</a>
105
+
106
+ <li><a href="./Firebind/TcpTransport.html">Firebind::TcpTransport</a>
107
+
108
+ <li><a href="./Firebind/Transport.html">Firebind::Transport</a>
109
+
110
+ <li><a href="./Firebind/UdpTransport.html">Firebind::UdpTransport</a>
111
+
112
+ <li><a href="./Runner.html">Runner</a>
113
+
114
+ <li><a href="./TestPortspec.html">TestPortspec</a>
115
+
116
+ <li><a href="./Tools.html">Tools</a>
117
+
118
+ </ul>
119
+ </nav>
120
+
121
+ </div>
122
+ </nav>
123
+
124
+ <div id="documentation" class="description">
125
+
126
+ <p>Firescan - path scan client</p>
127
+
128
+ <h2 id="label-Synopsis">Synopsis<span><a href="#label-Synopsis">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
129
+
130
+ <pre>This is the Ruby reference implementation for the Firebind Firescan
131
+ path scanner client.</pre>
132
+
133
+ <h2 id="label-Examples">Examples<span><a href="#label-Examples">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
134
+
135
+ <pre>This invocation performs a path scan on TCP ports 1-100 on target 192.168.100.1
136
+ firescan -s 192.168.100.1 -t 1-100
137
+
138
+ Other examples:
139
+ firescan -s 192.168.1.100 -u 1-100
140
+ firescan -n bob -p password123 -s 192.168.1.100 -u 1-100 -v</pre>
141
+
142
+ <h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
143
+
144
+ <pre> firescan [options]
145
+
146
+ For help use: firescan -h or firescan --help</pre>
147
+
148
+ <h2 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
149
+
150
+ <pre>Note that when invoked without a command server address, the client will default to the public service
151
+ located at scanme.firebind.com
152
+
153
+ -h, --help Show help and version
154
+ -v, --verbose Show verbose output
155
+ -s, --command-server ADDRESS Address:port or hostname:port of command server, default port is 80
156
+ -t, --tcp PORT_LIST TCP Port specification (list), use commas and dashes to specify a list of ports
157
+ -u, --udp PORT_LIST UDP Port specification (list), use commas and dashes to specify a list of ports
158
+ -i, --timeout TIMEOUT Timeout (in milliseconds) to use for connect, transmit and receive operations
159
+ -n, --username USERNAME Specify a username (to connect to command server)
160
+ -p, --password PASSWORD Specify a password (to connect to command server)
161
+ -r, --protocol PROTOCOL Specify a protocol
162
+ -g, --tag TAG tag the scan with value
163
+ -l, --localaddr LOCAL_ADDRESS Specify local IP address for client binding
164
+ -d, --xdebug Show debug output</pre>
165
+
166
+ <h2 id="label-Author">Author<span><a href="#label-Author">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
167
+
168
+ <pre>Jay Houghton (jay@firebind.com)</pre>
169
+
170
+ <h2 id="label-Copyright">Copyright<span><a href="#label-Copyright">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
171
+
172
+ <pre>Copyright (c) 2013 Firebind Inc. Licensed under the Apache 2.0 License:
173
+ http://www.apache.org/licenses/LICENSE-2.0.html</pre>
174
+
175
+ </div>
176
+
177
+
178
+
179
+ <footer id="validator-badges">
180
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
181
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
182
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
183
+ </footer>
184
+