Bring rapid7#6638 up to date

Author: wchen-r7

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,41 @@
+## Steps to reproduce
+
+How'd you do it?
+
+1. ...
+2. ...
+
+This section should also tell us any relevant information about the
+environment; for example, if an exploit that used to work is failing,
+tell us the victim operating system and service versions.
+
+## Expected behavior
+
+What should happen?
+
+## Current behavior
+
+What happens instead?
+
+You might also want to check the last ~1k lines of
+`/opt/metasploit/apps/pro/engine/config/logs/framework.log` or
+`~/.msf4/logs/framework.log` for relevant stack traces
+
+
+## System stuff
+
+### Metasploit version
+
+Get this with the `version` command in msfconsole (or `git log -1 --pretty=oneline` for a source install).
+
+### I installed Metasploit with:
+- [ ] Kali package via apt
+- [ ] Omnibus installer (nightly)
+- [ ] Commercial/Community installer (from http://www.rapid7.com/products/metasploit/download.jsp)
+- [ ] Source install (please specify ruby version)
+
+### OS
+
+What OS are you running Metasploit on?
+
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+
+Tell us what this change does. If you're fixing a bug, please mention
+the github issue number.
+
+## Verification
+
+List the steps needed to make sure this thing works
+
+- [ ] Start `msfconsole`
+- [ ] `use exploit/windows/smb/ms08_067_netapi`
+- [ ] ...
+- [ ] **Verify** the thing does what it should
+- [ ] **Verify** the thing does not do what it should not
+

.gitignore

@@ -84,3 +84,4 @@ data/meterpreter/ext_server_pivot.*.dll
 # Avoid checking in metakitty, the source for
 # https://rapid7.github.io/metasploit-framework. It's an orphan branch.
 /metakitty
+.vagrant

.mailmap

@@ -1,8 +1,11 @@
 acammack-r7 <acammack-r7@github>     Adam Cammack <[email protected]>
 bcook-r7 <bcook-r7@github>           <[email protected]>
 bcook-r7 <bcook-r7@github>           Brent Cook <[email protected]>
-bturner-r7 <bturner-r7@github>       Brandon Turner <[email protected]>
 bpatterson-r7 <bpatterson-r7@github> Brian Patterson <[email protected]>
+bpatterson-r7 <bpatterson-r7@github> bpatterson-r7 <[email protected]>
+bturner-r7 <bturner-r7@github>       Brandon Turner <[email protected]>
+bwatters-r7 <bwatters-r7@github>     Brendan <[email protected]>
+bwatters-r7 <bwatters-r7@github>     Brendan Watters <[email protected]>
 cdoughty-r7 <cdoughty-r7@github>     Chris Doughty <[email protected]>
 dheiland-r7 <dheiland-r7@github>     Deral Heiland <[email protected]>
 dmaloney-r7 <dmaloney-r7@github>     David Maloney <[email protected]>
@@ -16,30 +19,40 @@ ecarey-r7 <ecarey-r7@github>         Erran Carey <[email protected]>
 farias-r7 <farias-r7@github>         Fernando Arias <[email protected]>
 gmikeska-r7 <gmikeska-r7@github>     Greg Mikeska <[email protected]>
 gmikeska-r7 <gmikeska-r7@github>     Gregory Mikeska <[email protected]>
+jbarnett-r7 <jbarnett-r7@github>     James Barnett <[email protected]>
 jhart-r7 <jhart-r7@github>           Jon Hart <[email protected]>
 jlee-r7 <jlee-r7@github>             <[email protected]> # aka egypt
 jlee-r7 <jlee-r7@github>             <[email protected]>
 kgray-r7 <kgray-r7@github>           Kyle Gray <[email protected]>
+khayes-r7 <khayes-r7@github>         l0gan <[email protected]>
 lsanchez-r7 <lsanchez-r7@github>     Lance Sanchez <[email protected]>
 lsanchez-r7 <lsanchez-r7@github>     Lance Sanchez <[email protected]>
 lsanchez-r7 <lsanchez-r7@github>     Lance Sanchez <[email protected]>
 lsanchez-r7 <lsanchez-r7@github>     Lance Sanchez <[email protected]>
 lsanchez-r7 <lsanchez-r7@github>     darkbushido <[email protected]>
 lsato-r7 <lsato-r7@github>           Louis Sato <[email protected]>
+pbarry-r7 <pbarry-r7@github>         Pearce Barry <[email protected]>
 pdeardorff-r7 <pdeardorff-r7@github> Paul Deardorff <[email protected]>
 pdeardorff-r7 <pdeardorff-r7@github> pdeardorff-r7 <[email protected]>
+sdavis-r7 <sdavis-r7@github>         Scott Davis <[email protected]>
+sdavis-r7 <sdavis-r7@github>         Scott Lee Davis <[email protected]>
+sdavis-r7 <sdavis-r7@github>         Scott Lee Davis <[email protected]>
+sgonzalez-r7 <sgonzalez-r7@github>   Sonny Gonzalez <[email protected]>
 sgonzalez-r7 <sgonzalez-r7@github>   Sonny Gonzalez <[email protected]>
 shuckins-r7 <shuckins-r7@github>     Samuel Huckins <[email protected]>
+tdoan-r7 <tdoan-r7@github>           tdoan-r7 <[email protected]>
+tdoan-r7 <tdoan-r7@github>           thao doan <[email protected]>
 todb-r7 <todb-r7@github>             Tod Beardsley <[email protected]>
 todb-r7 <todb-r7@github>             Tod Beardsley <[email protected]>
 todb-r7 <todb-r7@github>             Tod Beardsley <[email protected]>
 wchen-r7 <wchen-r7@github>           <[email protected]> # aka sinn3r
 wchen-r7 <wchen-r7@github>           <[email protected]>
 wvu-r7 <wvu-r7@github>               William Vu <[email protected]>
+wvu-r7 <wvu-r7@github>               William Vu <[email protected]>
 wvu-r7 <wvu-r7@github>               William Vu <[email protected]>
-wvu-r7 <wvu-r7@github>               William Vu <[email protected]>
 wvu-r7 <wvu-r7@github>               wvu-r7 <[email protected]>
 wwebb-r7 <wwebb-r7@github>           William Webb <[email protected]>
+wwebb-r7 <wwebb-r7@github>           wwebb-r7 <[email protected]>
 
 # Above this line are current Rapid7 employees. Below this paragraph are
 # volunteers, former employees, and potential Rapid7 employees who, at
@@ -114,6 +127,7 @@ m-1-k-3 <m-1-k-3@github>               Michael Messner <[email protected]>
 Meatballs1 <Meatballs1@github>         <[email protected]>
 Meatballs1 <Meatballs1@github>         <[email protected]>
 mubix <mubix@github>                   Rob Fuller <[email protected]>
+net-ninja <[email protected]>       Steven Seeley <[email protected]>
 nevdull77 <nevdull77@github>           Patrik Karlsson <[email protected]>
 nmonkee <nmonkee@github>               nmonkee <[email protected]>
 nullbind <nullbind@github>             nullbind <[email protected]>
@@ -150,10 +164,11 @@ void-in <void-in@github>               void_in <[email protected]>
 void-in <void-in@github>               Waqas Ali <[email protected]>
 zeroSteiner <zeroSteiner@github>       Spencer McIntyre <[email protected]>
 
-
 # Aliases for utility author names. Since they're fake, typos abound
 
-Tab Assassin <[email protected]> Tabassassin <[email protected]>
+Metasploit Bot <[email protected]>    Metasploit <[email protected]>
+Jenkins Bot <[email protected]>          Jenkins <[email protected]>
 Tab Assassin <[email protected]> TabAssassin <[email protected]>
+Tab Assassin <[email protected]> Tabassassin <[email protected]>
 Tab Assassin <[email protected]> Tabasssassin <[email protected]>
 Tab Assassin <[email protected]> URI Assassin <[email protected]>

.ruby-version

@@ -1 +1 @@
-2.1.8
+2.3.1

.travis.yml

@@ -1,11 +1,22 @@
+sudo: false
+group: stable
 bundler_args: --without coverage development pcap
 cache: bundler
+addons:
+  postgresql: '9.3'
+  apt:
+    packages:
+      - libpcap-dev
+      - graphviz
+language: ruby
+rvm:
+  - '2.3.1'
+
 env:
   - RAKE_TASKS="cucumber cucumber:boot" CREATE_BINSTUBS=true
   - RAKE_TASKS=spec SPEC_OPTS="--tag content"
   - RAKE_TASKS=spec SPEC_OPTS="--tag ~content"
 
-language: ruby
 matrix:
   fast_finish: true
 before_install:
@@ -23,9 +34,6 @@ before_script:
 script:
   # fail build if db/schema.rb update is not committed
   - git diff --exit-code db/schema.rb && bundle exec rake $RAKE_TASKS
-sudo: false
-rvm:
-  - '2.1.8'
 
 notifications:
   irc: "irc.freenode.org#msfnotify"
@@ -38,9 +46,3 @@ branches:
   except:
     - gh-pages
     - metakitty
-
-addons:
-  postgresql: '9.3'
-  apt:
-    packages:
-      - libpcap-dev

CONTRIBUTING.md

@@ -45,6 +45,8 @@ and Metasploit's [Common Coding Mistakes].
 * **Do** specify a descriptive title to make searching for your pull request easier.
 * **Do** include [console output], especially for witnessable effects in `msfconsole`.
 * **Do** list [verification steps] so your code is testable.
+* **Do** [reference associated issues] in your pull request description
+* **Do** write [release notes] once a pull request is landed
 * **Don't** leave your pull request description blank.
 * **Don't** abandon your pull request. Being responsive helps us land your code faster.
 
@@ -56,6 +58,10 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
   - It would be even better to set up `msftidy.rb` as a [pre-commit hook].
 * **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much.
 * **Don't** include more than one module per pull request.
+* **Do** include instructions on how to setup the vulnerable environment or software
+* **Do** include [Module Documentation](https://github.com/rapid7/metasploit-framework/wiki/Generating-Module-Documentation) showing sample run-throughs
+
+
 
 #### Scripts
 
@@ -102,6 +108,8 @@ already way ahead of the curve, so keep it up!
 [topic branch]:http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches
 [console output]:https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks
 [verification steps]:https://help.github.com/articles/writing-on-github#task-lists
+[reference associated issues]:https://github.com/blog/1506-closing-issues-via-pull-requests
+[release notes]:https://github.com/rapid7/metasploit-framework/wiki/Adding-Release-Notes-to-PRs
 [PR#2940]:https://github.com/rapid7/metasploit-framework/pull/2940
 [PR#3043]:https://github.com/rapid7/metasploit-framework/pull/3043
 [pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb

Gemfile

@@ -18,18 +18,21 @@ group :development do
   gem 'yard'
   # for development and testing purposes
   gem 'pry'
+  # module documentation
+  gem 'octokit', '~> 4.0'
+  # rails-upgrade staging gems
 end
 
 group :development, :test do
   # automatically include factories from spec/factories
-  gem 'factory_girl_rails', '~> 4.5.0'
+  gem 'factory_girl_rails'
   # Make rspec output shorter and more useful
-  gem 'fivemat', '~> 1.3.1'
+  gem 'fivemat'
   # running documentation generation tasks and rspec tasks
-  gem 'rake', '>= 10.0.0'
+  gem 'rake'
   # Define `rake spec`.  Must be in development AND test so that its available by default as a rake test when the
   # environment is development
-  gem 'rspec-rails' , '~> 3.3'
+  gem 'rspec-rails'
 end
 
 group :test do