Merge branch 'rapid7' into kernelsmith-console-alias-plugin

Author: egypt

.gitignore

@@ -1,10 +1,23 @@
+# Rubymine project directory
+.idea
+# RVM control file
+.rvmrc
+# YARD cache directory
+.yardoc
+# Mac OS X files
+.DS_Store
+# simplecov coverage data
+coverage
 data/meterpreter/ext_server_pivot.dll
 data/meterpreter/ext_server_pivot.x64.dll
+doc
 external/source/meterpreter/java/bin
 external/source/meterpreter/java/build
 external/source/meterpreter/java/extensions
 external/source/javapayload/bin
 external/source/javapayload/build
+# Packaging directory
+pkg
 tags
 *.swp
 *.orig

.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - '1.8.7'
+  - '1.9.3'
+
+matrix:
+  allow_failures:
+    - rvm: '1.8.7'
+
+notifications:
+  irc: "irc.freenode.org#msfnotify"
+

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to Metasploit
+
+## Reporting Bugs
+
+If you would like to report a bug, please take a look at [our Redmine
+issue
+tracker](https://dev.metasploit.com/redmine/projects/framework/issues?query_id=420)
+-- your bug may already have been reported there! Simply [searching](https://dev.metasploit.com/redmine/projects/framework/search) for some appropriate keywords may save everyone a lot of hassle.
+
+If your bug is new and you'd like to report it you will need to
+[register
+first](https://dev.metasploit.com/redmine/account/register). Don't
+worry, it's easy and fun and takes about 30 seconds.
+
+## Contributing Metasploit Modules
+
+If you have an exploit that you'd like to contribute to the Metasploit
+Framework, please familiarize yourself with the
+**[HACKING](https://github.com/rapid7/metasploit-framework/blob/master/HACKING)**
+document in the
+Metasploit-Framework repository. There are many mysteries revealed in
+HACKING concerning code style and content.
+
+[Pull requests](https://github.com/rapid7/metasploit-framework/pulls)
+should corellate with modules at a 1:1 ratio
+-- there is rarely a good reason to have two, three, or ten modules on
+one pull request, as this dramatically increases the review time
+required to land (commit) any of those modules.
+
+Pull requests tend to be very collaborative for Metasploit -- do not be
+surprised if your pull request to rapid7/metasploit-framework triggers a
+pull request back to your own fork. In this way, we can isolate working
+changes before landing your PR to the Metasploit master branch.

Gemfile

@@ -1,6 +1,30 @@
 source 'http://rubygems.org'
-gem 'rails', '3.2.2'
-gem 'metasploit_data_models', '0.0.2', :git => "git://github.com/rapid7/metasploit_data_models.git"
-gem 'pg', '>=0.13'
-gem 'msgpack'
-gem 'nokogiri'
+
+# Need 3+ for ActiveSupport::Concern
+gem 'activesupport', '>= 3.0.0'
+# Needed for Msf::DbManager
+gem 'activerecord'
+# Database models shared between framework and Pro.
+gem 'metasploit_data_models', :git => 'git://github.com/rapid7/metasploit_data_models.git', :tag => '0.3.0'
+# Needed for module caching in Mdm::ModuleDetails
+gem 'pg', '>= 0.11'
+
+group :development do
+  # Markdown formatting for yard
+  gem 'redcarpet'
+  # generating documentation
+  gem 'yard'
+end
+
+group :development, :test do
+  # running documentation generation tasks and rspec tasks
+  gem 'rake'
+end
+
+group :test do
+  # testing framework
+  gem 'rspec'
+  # code coverage for tests
+  # any version newer than 0.5.4 gives an Encoding error when trying to read the source files.
+  gem 'simplecov', '0.5.4', :require => false
+end

Gemfile.lock

@@ -0,0 +1,68 @@
+GIT
+  remote: git://github.com/rapid7/metasploit_data_models.git
+  revision: 73f26789500f278dd6fd555e839d09a3b81a05f4
+  tag: 0.3.0
+  specs:
+    metasploit_data_models (0.3.0)
+      activerecord
+      activesupport
+      pg
+      pry
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.3)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    multi_json (1.3.6)
+    pg (0.14.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (3.3.3)
+    tzinfo (0.3.33)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activesupport (>= 3.0.0)
+  metasploit_data_models!
+  pg (>= 0.11)
+  rake
+  redcarpet
+  rspec
+  simplecov (= 0.5.4)
+  yard

HACKING

@@ -34,7 +34,7 @@ puts.
 2. Don't read from standard input, doing so will make your code 
 lock up the entire module when called from other interfaces. If you 
 need user input, you can either register an option or expose an 
-interactve session type specific for the type of exploit.
+interactive session type specific for the type of exploit.
 
 3. Don't use "sleep". It has been known to cause issues with
 multi-threaded programs on various platforms. Instead, we use
@@ -48,7 +48,7 @@ the creation of ruby sockets and won't know how to clean them up in
 case your module raises an exception without cleaning up after itself.
 Secondly, non-Rex sockets do not know about routes and therefore can't
 be used through a meterpreter tunnel.  Lastly, regular sockets miss
-out on msf's proxy and ssl features.  Msf includes many protocols
+out on msf's proxy and SSL features.  Msf includes many protocols
 already implemented with Rex and if the protocol you need is missing,
 porting another library to use them is straight-forward.  See our
 Net::SSH modifications in lib/net/ssh/ for an example.
@@ -121,8 +121,8 @@ development team. Note that this process requires a GitHub account.
 
 For Git commits, please adhere to 50/72 formatting: your commits should
 start with a line 50 characters or less, followed by a blank line,
-followed by one or more lines of explanitory text wrapped at at 72
-characters Pull requests with commits not formmated this way will
+followed by one or more lines of explanatory text wrapped at at 72
+characters Pull requests with commits not formatted this way will
 be rejected without review.
 
 For modules, note that Author field is not automatic, and should be 

README.md

@@ -1,5 +1,5 @@
 
-Metasploit
+Metasploit [![Build Status](https://travis-ci.org/rapid7/metasploit-framework.png)](https://travis-ci.org/rapid7/metasploit-framework) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rapid7/metasploit-framework)
 ==
 The Metasploit Framework is released under a BSD-style license. See
 COPYING for more details.
@@ -40,10 +40,11 @@ reading some of the great tutorials online:
 
 Contributing
 --
-See the [Dev Environment Setup][wiki-devenv] guide on github which will
+See the [Dev Environment Setup][wiki-devenv] guide on GitHub which will
 walk you through the whole process starting from installing all the
 dependencies, to cloning the repository, and finally to submitting a
-pull request.
+pull request. For slightly more info, see
+[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
 
 
 [wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Metasploit-Development-Environment "Metasploit Development Environment Setup"

Rakefile

@@ -0,0 +1,47 @@
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :yard do
+  yard_files = [
+      # Ruby source files first
+      'lib/msf/**/*.rb',
+      'lib/rex/**/*.rb',
+      # Anything after '-' is a normal documentation, not source
+      '-',
+      'COPYING',
+      'HACKING',
+      'THIRD-PARTY.md'
+  ]
+  yard_options = [
+      # include documentation for protected methods for developers extending the code.
+      '--protected'
+  ]
+
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files = yard_files
+    # --no-stats here as 'stats' task called after will print fuller stats
+    t.options = yard_options + ['--no-stats']
+
+    t.after = Proc.new {
+      Rake::Task['yard:stats'].execute
+    }
+  end
+
+  desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
+  task :stats => :environment do
+    stats = YARD::CLI::Stats.new
+    yard_arguments = yard_options + ['--compact', '--list-undoc'] + yard_files
+    stats.run(*yard_arguments)
+  end
+end
+
+# @todo Figure out how to just clone description from yard:doc
+desc "Generate YARD documentation"
+# allow calling namespace to as a task that goes to default task for namespace
+task :yard => ['yard:doc']