Land rapid7#6708, module documentation for msfconsole

Author: tdoan-r7

Gemfile

@@ -18,6 +18,8 @@ group :development do
   gem 'yard'
   # for development and testing purposes
   gem 'pry'
+  # module documentation
+  gem 'octokit', '~> 4.0'
   # rails-upgrade staging gems
 end
 

Gemfile.lock

@@ -18,13 +18,15 @@ PATH
       msgpack
       network_interface (~> 0.0.1)
       nokogiri
+      octokit
       openssl-ccm (= 1.2.1)
       packetfu (= 1.1.11)
       pcaprub
       pg (>= 0.11)
       railties
       rb-readline-r7
       recog (= 2.0.14)
+      redcarpet
       robots
       rubyzip (~> 1.1)
       sqlite3
@@ -57,6 +59,7 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
+    addressable (2.3.8)
     arel (4.0.2)
     arel-helpers (2.2.0)
       activerecord (>= 3.1.0, < 5)
@@ -95,6 +98,8 @@ GEM
     factory_girl_rails (4.5.0)
       factory_girl (~> 4.5.0)
       railties (>= 3.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
     ffi (1.9.8)
     filesize (0.1.1)
     fivemat (1.3.2)
@@ -142,9 +147,12 @@ GEM
     msgpack (0.7.4)
     multi_json (1.11.2)
     multi_test (0.1.2)
+    multipart-post (2.0.0)
     network_interface (0.0.1)
     nokogiri (1.6.7.2)
       mini_portile2 (~> 2.0.0.rc2)
+    octokit (4.2.0)
+      sawyer (~> 0.6.0, >= 0.5.3)
     openssl-ccm (1.2.1)
     packetfu (1.1.11)
       network_interface (~> 0.0)
@@ -202,6 +210,9 @@ GEM
     rspec-support (3.3.0)
     rubyntlm (0.6.0)
     rubyzip (1.2.0)
+    sawyer (0.6.0)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
     simplecov (0.9.2)
@@ -238,6 +249,7 @@ DEPENDENCIES
   factory_girl_rails (~> 4.5.0)
   fivemat (~> 1.3.1)
   metasploit-framework!
+  octokit (~> 4.0)
   pry
   rake (>= 10.0.0)
   redcarpet

data/markdown_doc/auxiliary_scanner_template.erb

@@ -0,0 +1,29 @@
+This module is a scanner module, and is capable of testing against multiple hosts.
+
+```
+msf > use <%= mod.fullname %>
+msf <%= mod.type %>(<%= mod.shortname %>) > show options
+    ... show and set options ...
+msf <%= mod.type %>(<%= mod.shortname %>) > set RHOSTS ip-range
+msf <%= mod.type %>(<%= mod.shortname %>) > exploit
+```
+
+Other examples of setting the RHSOTS option:
+
+Example 1:
+
+```
+msf <%= mod.type %>(<%= mod.shortname %>) > set RHOSTS 192.168.1.3-192.168.1.200 
+```
+
+Example 2:
+
+```
+msf <%= mod.type %>(<%= mod.shortname %>) > set RHOSTS 192.168.1.1/24
+```
+
+Example 3:
+
+```
+msf <%= mod.type %>(<%= mod.shortname %>) > set RHOSTS file:///tmp/ip_list.txt
+```

data/markdown_doc/bes_demo_template.erb

@@ -0,0 +1,15 @@
+```
+msf > use <%= mod.fullname %>
+msf <%= mod.type %>(<%= mod.shortname %>) > run
+```
+
+This module is also supported by Browser Autopwn 2.
+
+To load it from Browser Autopwn 2, here's how:
+
+```
+msf > use auxiliary/server/browser_autopwn2 
+msf auxiliary(browser_autopwn2) > set INCLUDE_PATTERN <%= mod.shortname %>
+INCLUDE_PATTERN => <%= mod.shortname %>
+msf auxiliary(browser_autopwn2) > exploit
+```

data/markdown_doc/default_template.erb

@@ -0,0 +1,50 @@
+## <%= items[:mod_name] %>
+<p>
+<%= normalize_description(items[:mod_description]) %>
+</p>
+
+## Module Name
+
+<%= Rex::Text.html_encode(items[:mod_fullname]) %>
+
+## Authors
+
+<%= normalize_authors(items[:mod_authors]) %>
+
+<% unless items[:mod_platforms].empty? %>
+## Platforms
+<%= normalize_platforms(items[:mod_platforms]) %>
+<% end %>
+
+## Reliability
+
+<%= normalize_rank(items[:mod_rank]) %>
+
+## Related Pull Requests
+
+<%= normalize_pull_requests(items[:mod_pull_requests]) %>
+
+<% unless items[:mod_refs].empty? %>
+## References
+
+<%= normalize_references(items[:mod_refs]) %>
+<% end %>
+
+<% if items[:mod_targets] %>
+## Available Targets
+
+<%= normalize_targets(items[:mod_targets]) %>
+
+<% end %>
+
+## Required Options
+
+<% if normalize_options(items[:mod_options]).empty? %>
+No options required.
+<% else %>
+<%= normalize_options(items[:mod_options]) %>
+<% end %>
+
+## Basic Usage
+
+<%= normalize_demo_output(items[:mod_demo]) %>

data/markdown_doc/generic_demo_template.erb

@@ -0,0 +1,9 @@
+```
+msf > use <%= mod.fullname %>
+msf <%= mod.type %>(<%= mod.shortname %>) > show targets
+    ... a list of targets ...
+msf <%= mod.type %>(<%= mod.shortname %>) > set TARGET target-id
+msf <%= mod.type %>(<%= mod.shortname %>) > show options
+    ... show and set options ...
+msf <%= mod.type %>(<%= mod.shortname %>) > exploit
+```

data/markdown_doc/html_template.erb

@@ -0,0 +1,54 @@
+<html>
+<head>
+<% unless kb.empty? %>
+<script>
+  function showOverview() {
+    var overview_info_button = document.getElementById('overview_info_button');
+    overview_info_button.style.borderColor = "#ccc";
+    overview_info_button.style.color = "#333";
+    var knowledge_base_button = document.getElementById('knowledge_base_button');
+    knowledge_base_button.style.borderColor = "#EEEEEE";
+    knowledge_base_button.style.color = "#C4C4C4";
+    document.getElementById('knowledge_base').style.display = "none";
+    document.getElementById('overview_info').style.display = "inline";
+  }
+
+  function showKnowledge() {
+    var overview_info_button = document.getElementById('overview_info_button');
+    overview_info_button.style.borderColor = "#EEEEEE";
+    overview_info_button.style.color = "#C4C4C4";
+    var knowledge_base_button = document.getElementById('knowledge_base_button');
+    knowledge_base_button.style.borderColor = "#ccc";
+    knowledge_base_button.style.color = "#333";
+    document.getElementById('overview_info').style.display = "none";
+    document.getElementById('knowledge_base').style.display = "inline";
+  }
+</script>
+<% end %>
+<style>
+<%= load_css %>
+</style>
+</head>
+<body>
+<% unless kb.empty? %>
+<table border="0">
+<tr>
+<th>
+<div id="overview_info_button" onClick="showOverview()">Overview</a>
+</th>
+<th>
+<div id="knowledge_base_button" onClick="showKnowledge()">Knowledge Base</a>
+</th>
+</tr></table>
+<p></p>
+<% end %>
+<div id="overview_info">
+<%= r.render(md) %>
+</div>
+<% unless kb.empty? %>
+<div id="knowledge_base">
+<%= r.render(kb) %>
+</div>
+<% end %>
+</body>
+</html>

data/markdown_doc/httpserver_demo_template.erb

@@ -0,0 +1,4 @@
+```
+msf > use <%= mod.fullname %>
+msf <%= mod.type %>(<%= mod.shortname %>) > exploit
+```

data/markdown_doc/localexploit_demo_template.erb

@@ -0,0 +1,14 @@
+Note: To run a local exploit, make sure you are at the msf prompt.
+Also, to check the session ID, use the ```sessions``` command.
+
+
+```
+msf > use <%= mod.fullname %>
+msf <%= mod.type %>(<%= mod.shortname %>) > show targets
+    ... a list of targets ...
+msf <%= mod.type %>(<%= mod.shortname %>) > set TARGET target-id
+msf <%= mod.type %>(<%= mod.shortname %>) > show options
+    ... show and set options ...
+msf <%= mod.type %>(<%= mod.shortname %>) > set SESSION session-id
+msf <%= mod.type %>(<%= mod.shortname %>) > exploit
+```