Merge branch 'landing/4135' into upstream-master

Land rapid7#4135

* Improve Bundle management:
* Option to install w/out DB group
* Option to install w/out pcap support

Author: trevrosen

Gemfile

@@ -1,18 +1,10 @@
 source 'https://rubygems.org'
 # Add default group gems to `metasploit-framework.gemspec`:
 #   spec.add_runtime_dependency '<name>', [<version requirements>]
-gemspec
+gemspec name: 'metasploit-framework'
 
 group :db do
-  # Needed for Msf::DbManager
-  gem 'activerecord', '>= 3.0.0', '< 4.0.0'
-
-  # Metasploit::Credential database models
-  gem 'metasploit-credential', '~> 0.12.0'
-  # Database models shared between framework and Pro.
-  gem 'metasploit_data_models', '~> 0.21.1'
-  # Needed for module caching in Mdm::ModuleDetails
-  gem 'pg', '>= 0.11'
+  gemspec name: 'metasploit-framework-db'
 end
 
 group :development do
@@ -43,9 +35,7 @@ group :development, :test do
 end
 
 group :pcap do
-  gem 'network_interface', '~> 0.0.1'
-  # For sniffer and raw socket modules
-  gem 'pcaprub'
+  gemspec name: 'metasploit-framework-pcap'
 end
 
 group :test do

Gemfile.lock

@@ -20,6 +20,16 @@ PATH
       rubyzip (~> 1.1)
       sqlite3
       tzinfo
+    metasploit-framework-db (4.10.1.pre.dev)
+      activerecord (< 4.0.0)
+      metasploit-credential (~> 0.12.0)
+      metasploit-framework (= 4.10.1.pre.dev)
+      metasploit_data_models (~> 0.21.1)
+      pg (>= 0.11)
+    metasploit-framework-pcap (4.10.1.pre.dev)
+      metasploit-framework (= 4.10.1.pre.dev)
+      network_interface (~> 0.0.1)
+      pcaprub
 
 GEM
   remote: https://rubygems.org/
@@ -218,18 +228,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 3.0.0, < 4.0.0)
   aruba
   cucumber-rails
   factory_girl (>= 4.1.0)
   factory_girl_rails
   fivemat (= 1.2.1)
-  metasploit-credential (~> 0.12.0)
   metasploit-framework!
-  metasploit_data_models (~> 0.21.1)
-  network_interface (~> 0.0.1)
-  pcaprub
-  pg (>= 0.11)
+  metasploit-framework-db!
+  metasploit-framework-pcap!
   pry
   rake (>= 10.0.0)
   redcarpet

lib/metasploit/framework/require.rb

@@ -80,13 +80,18 @@ def self.optionally_include_metasploit_credential_creation(including_module)
       # @return [void]
       def self.optionally_require_metasploit_db_gem_engines
         optionally(
-          'metasploit/credential/engine',
-          'metasploit-credential not in the bundle',
-        )
+            'metasploit/credential',
+            'metasploit-credential not in the bundle',
+        ) do
+          require 'metasploit/credential/engine'
+        end
+
         optionally(
-          'metasploit_data_models/engine',
-          'metaspoit_data_models not in the bundle'
-        )
+          'metasploit_data_models',
+          'metasploit_data_models not in the bundle'
+        ) do
+          require 'metasploit_data_models/engine'
+        end
       end
 
       #

metasploit-framework-db.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+# During build, the Gemfile is temporarily moved and
+# we must manually define the project root
+if ENV['MSF_ROOT']
+  lib = File.realpath(File.expand_path('lib', ENV['MSF_ROOT']))
+else
+  # have to use realpath as metasploit-framework is often loaded through a symlink and tools like Coverage and debuggers
+  # require realpaths.
+  lib = File.realpath(File.expand_path('../lib', __FILE__))
+end
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metasploit/framework/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metasploit-framework-db'
+  spec.version       = Metasploit::Framework::GEM_VERSION
+  spec.authors       = ['Metasploit Hackers']
+  spec.email         = ['[email protected]']
+  spec.summary       = 'metasploit-framework Database dependencies'
+  spec.description   = 'Gems needed to access the PostgreSQL database in metasploit-framework'
+  spec.homepage      = 'https://www.metasploit.com'
+  spec.license       = 'BSD-3-clause'
+
+  # no files, just dependencies
+  spec.files         = []
+
+  # The Metasploit ecosystem is not ready for Rails 4 as it uses features of Rails 3.X that are removed in Rails 4.
+  rails_version_constraint = '< 4.0.0'
+
+  spec.add_runtime_dependency 'activerecord', rails_version_constraint
+  # Metasploit::Credential database models
+  spec.add_runtime_dependency 'metasploit-credential', '~> 0.12.0'
+  # Database models shared between framework and Pro.
+  spec.add_runtime_dependency 'metasploit_data_models', '~> 0.21.1'
+  # depend on metasploit-framewrok as the optional gems are useless with the actual code
+  spec.add_runtime_dependency 'metasploit-framework', "= #{spec.version}"
+  # Needed for module caching in Mdm::ModuleDetails
+  spec.add_runtime_dependency 'pg', '>= 0.11'
+end

metasploit-framework-full.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+# During build, the Gemfile is temporarily moved and
+# we must manually define the project root
+if ENV['MSF_ROOT']
+  lib = File.realpath(File.expand_path('lib', ENV['MSF_ROOT']))
+else
+  # have to use realpath as metasploit-framework is often loaded through a symlink and tools like Coverage and debuggers
+  # require realpaths.
+  lib = File.realpath(File.expand_path('../lib', __FILE__))
+end
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metasploit/framework/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metasploit-framework-full'
+  spec.version       = Metasploit::Framework::GEM_VERSION
+  spec.authors       = ['Metasploit Hackers']
+  spec.email         = ['[email protected]']
+  spec.summary       = 'metasploit-framework with all optional dependencies'
+  spec.description   = 'Gems needed to access the PostgreSQL database in metasploit-framework'
+  spec.homepage      = 'https://www.metasploit.com'
+  spec.license       = 'BSD-3-clause'
+
+  # no files, just dependencies
+  spec.files         = []
+
+  metasploit_framework_version_constraint = "= #{spec.version}"
+
+  spec.add_runtime_dependency 'metasploit-framework', metasploit_framework_version_constraint
+  spec.add_runtime_dependency 'metasploit-framework-db', metasploit_framework_version_constraint
+  spec.add_runtime_dependency 'metasploit-framework-pcap', metasploit_framework_version_constraint
+end

metasploit-framework-pcap.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+# During build, the Gemfile is temporarily moved and
+# we must manually define the project root
+if ENV['MSF_ROOT']
+  lib = File.realpath(File.expand_path('lib', ENV['MSF_ROOT']))
+else
+  # have to use realpath as metasploit-framework is often loaded through a symlink and tools like Coverage and debuggers
+  # require realpaths.
+  lib = File.realpath(File.expand_path('../lib', __FILE__))
+end
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metasploit/framework/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metasploit-framework-pcap'
+  spec.version       = Metasploit::Framework::GEM_VERSION
+  spec.authors       = ['Metasploit Hackers']
+  spec.email         = ['[email protected]']
+  spec.summary       = 'metasploit-framework packet capture dependencies'
+  spec.description   = 'Gems needed to capture packets in metasploit-framework'
+  spec.homepage      = 'https://www.metasploit.com'
+  spec.license       = 'BSD-3-clause'
+
+  # no files, just dependencies
+  spec.files         = []
+
+  # depend on metasploit-framewrok as the optional gems are useless with the actual code
+  spec.add_runtime_dependency 'metasploit-framework', "= #{spec.version}"
+  # get list of network interfaces, like eth* from OS.
+  spec.add_runtime_dependency 'network_interface', '~> 0.0.1'
+  # For sniffer and raw socket modules
+  spec.add_runtime_dependency 'pcaprub'
+end