Metasploit Framework
 
 
 
 
 
 
Go to file
Brandon Turner fde119e889 Move optional gems to bundler groups
Some users are having trouble installing pcap.  Others want postgres to
remain optional.  The move to requiring bundler in a git environment has
made this hard.

This commit provides a path for these users.  By default, bundler will
install all gems, including postgres and pcaprub.  If it fails to
install some, Metasploit will not function.  But there is hope.  Users
can explicitly exclude the gem groups they don't want.

For example:

    bundle install --without db pcap

will exclude the pcap and postgres gems (and their depedencies).

    bundle install --without db pcap development test

will exclude all non-essential gems.

The good news is that the user only needs to use the `--without` option
once.  Bundler will remember it.  So future runs can still do `bundle
install` (or simply `bundle`) and the gems will still be excluded.  And
if the user changes their mind and wants the optional gems, they can
remove their stored *without* preference using:

    bundle config --delete without

[FIXRM #7891]
2013-04-12 09:47:40 -05:00
config Configure travis-ci to use database for rake spec 2013-03-15 08:48:20 -05:00
data Land #1660, dlink backdoor wordlist 2013-04-11 23:04:02 -05:00
db Allow use of rake db tasks 2013-03-14 15:46:18 -05:00
documentation Update Gemfile to metasploit_data_models 0.6.1 2013-03-07 14:22:35 -06:00
external Land #1217, java payload build system refactor 2013-04-11 13:10:03 -05:00
lib Bumping version. 2013-04-10 08:59:56 -05:00
modules Landing #1614, @jwpari nagios nrpe exploit 2013-04-11 17:53:52 +02:00
plugins indentation compliance 2013-03-07 14:57:03 -05:00
scripts Update keylogrecorder.rb 2013-03-22 10:57:10 -07:00
spec Fix typo in spec let 2013-04-02 09:11:43 -05:00
test Have Post::File use shiny new session.fs.file.mv 2013-04-05 01:24:24 -05:00
tools Remove the gemcache loader and tools 2013-04-03 16:24:56 -05:00
.gitignore Adding new .gitignores 2013-04-08 22:01:46 -05:00
.mailmap Updating mailmap 2013-04-09 15:34:51 -05:00
.rspec Fix missed rename when adding fastlib under directory 2012-10-08 16:14:37 -05:00
.simplecov Better Rubymine compatibility for .simplecov 2013-01-18 11:12:16 -06:00
.travis.yml Configure travis-ci to use database for rake spec 2013-03-15 08:48:20 -05:00
.yardopts Merge pull request #1563 from rapid7/bug/yard-guard 2013-03-07 17:35:03 -06:00
CONTRIBUTING.md Update CONTRIBUTING.md 2012-12-21 09:48:13 -06:00
COPYING Replace THIRD_PARTY with machine-readable LICENSE 2013-01-08 13:38:18 -06:00
Gemfile Move optional gems to bundler groups 2013-04-12 09:47:40 -05:00
Gemfile.lock Use metasploit_data_models from rubygems 2013-04-11 15:35:19 -05:00
HACKING Adding bundler step to HACKING 2013-04-05 10:18:58 -05:00
LICENSE Add last-updated to LICENSE 2013-03-25 15:33:34 -05:00
README.md Merge branch 'feature/contributing' of https://github.com/todb-r7/metasploit-framework into todb-r7-feature/contributing 2012-11-13 21:44:42 +01:00
Rakefile Specs for activerecord patch 2013-03-18 11:01:45 -05:00
armitage pass commandline arguments through to armitage.jar, fixes #3519 2011-01-13 16:04:42 +00:00
msfbinscan Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfcli Fix module reloading 2012-10-04 16:32:12 -05:00
msfconsole Fully deprecates msfupdate over SVN 2013-03-14 15:21:33 -05:00
msfd Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfelfscan Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfencode Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfgui Load environment before starting msfgui 2013-01-03 17:06:02 -06:00
msfmachscan Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfpayload Merge the commandline options with the payload's datastore 2012-07-16 16:07:54 -05:00
msfpescan Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfrop Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfrpc Remove unused option. 2013-03-25 20:47:18 -05:00
msfrpcd Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfupdate Automatically update gems after running msfupdate 2013-04-05 09:42:15 -05:00
msfvenom Import datastore options when using an encoder 2013-01-10 17:11:58 -06:00

README.md

Metasploit Build Status Code Climate

The Metasploit Framework is released under a BSD-style license. See COPYING for more details.

The latest version of this software is available from http://metasploit.com/

Bug tracking and development information can be found at: https://dev.metasploit.com/redmine/projects/framework/

The public GitHub source repository can be found at: https://github.com/rapid7/metasploit-framework

Questions and suggestions can be sent to: msfdev(at)metasploit.com

The framework mailing list is the place to discuss features and ask for help. To subscribe, visit the following web page: https://mail.metasploit.com/mailman/listinfo/framework

The mailing list archives are available from: https://mail.metasploit.com/pipermail/framework/

Installing

Generally, you should use the installer which contains all dependencies and will get you up and running with a few clicks. See the Dev Environment Setup if you'd like to deal with dependencies on your own.

Using Metasploit

Metasploit can do all sorts of things. The first thing you'll want to do is start msfconsole, but after that, you'll probably be best served by reading some of the great tutorials online:

Contributing

See the Dev Environment Setup 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. For slightly more info, see Contributing.