Metasploit Framework
 
 
 
 
 
 
Go to file
James Lee 3e898b28b3 Merge branch 'rapid7' into kernelsmith-console-alias-plugin 2012-11-20 17:39:28 -06:00
data Merge branch 'guiOptions' of git://github.com/scriptjunkie/metasploit-framework into scriptjunkie-guiOptions 2012-11-19 10:09:54 -06:00
documentation Change file header comment to new format 2012-10-08 21:30:42 -05:00
external Remember last options used for each module, and fill them in by default. 2012-11-17 10:08:45 -06:00
lib Remove trailing whitespace 2012-11-19 19:42:22 -06:00
modules Minor grammar touch on modbus_findunitid 2012-11-20 14:08:07 -06:00
plugins fix ^alias regex and mispelling in comments 2012-11-20 11:28:34 -06:00
scripts Switc smart mgirate to post mod as it should be 2012-10-31 17:03:49 -05:00
spec Fix 1.9ism that breaks specs on 1.8 2012-11-08 09:55:29 -06:00
test Move specs from test/tests/ into spec/ 2012-10-17 14:48:53 -05:00
tools Some examples of use 2012-11-20 10:30:27 -08:00
.gitignore Add simplecov for code coverage 2012-11-06 16:30:41 -06:00
.rspec Fix missed rename when adding fastlib under directory 2012-10-08 16:14:37 -05:00
.travis.yml Add IRC notifications and allow 1.8.7 to fail 2012-11-09 15:02:09 -06:00
CONTRIBUTING.md Update CONTRIBUTING.md 2012-11-19 11:20:40 -06:00
COPYING Committing Egypt's README updates 2012-05-30 10:42:52 -05:00
Gemfile Add simplecov for code coverage 2012-11-06 16:30:41 -06:00
Gemfile.lock Add simplecov for code coverage 2012-11-06 16:30:41 -06:00
HACKING Correct typos 2012-10-06 02:24:30 -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 Disambiguate with parens 2012-10-18 12:46:08 -05:00
THIRD-PARTY.md Adding carrierwave to metasploit's gemcache. 2012-06-12 14:47:50 -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 Touchups to msfconsole command parsing 2012-09-20 13:40:01 -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 Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05: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 Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfrpcd Mark all libraries as defaulting to 8-bit strings 2012-06-29 00:18:28 -05:00
msfupdate Be verbose about stashes 2012-11-05 14:52:14 -06:00
msfvenom Allow 'x64' and 'x86_64' for backcompat 2012-10-17 11:03:42 -05: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.