1
mirror of https://github.com/rapid7/metasploit-framework synced 2024-10-29 18:07:27 +01:00
Go to file
kernelsmith 6f73f79cbb change doc to doc/ in .gitignore
I think this is more inline with what's intended
2013-01-09 14:51:54 -06:00
data Turnkey Linux default password 2013-01-08 22:47:53 -05:00
documentation Change file header comment to new format 2012-10-08 21:30:42 -05:00
external Fix typo in license text 2013-01-07 23:29:49 -06:00
lib Merge branch 'mysql_login_exceptions' of https://github.com/wchen-r7/metasploit-framework into wchen-r7-mysql_login_exceptions 2013-01-09 18:21:03 +01:00
modules this rescue is done in the mixin 2013-01-09 21:28:06 +01:00
plugins Makes some small changes based on bperry's feedback 2012-11-27 00:31:31 -06:00
scripts Add a reference that's good for reading 2013-01-04 00:35:59 -06:00
spec trailing whitespace 2012-12-27 23:08:50 -06:00
test Fix whitespace, thanks mfstidy! 2012-11-07 19:05:37 -06:00
tools Correct unicode probs 2013-01-04 14:09:37 -06:00
.gitignore change doc to doc/ in .gitignore 2013-01-09 14:51:54 -06:00
.rspec Fix missed rename when adding fastlib under directory 2012-10-08 16:14:37 -05:00
.travis.yml Last commit should make 1.8.7 specs pass 2012-11-20 19:45:28 -06:00
armitage pass commandline arguments through to armitage.jar, fixes #3519 2011-01-13 16:04:42 +00: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 Upgrade rspec to 2.12 2012-12-12 15:36:06 -06:00
Gemfile.lock Upgrade rspec to 2.12 2012-12-12 15:36:06 -06:00
HACKING Correct typos 2012-10-06 02:24:30 -05:00
LICENSE Replace THIRD_PARTY with machine-readable LICENSE 2013-01-08 13:38:18 -06: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 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 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 Fixes a pro bug with updating 2012-11-30 16:51:03 -06:00
msfvenom Allow 'x64' and 'x86_64' for backcompat 2012-10-17 11:03:42 -05:00
Rakefile Disambiguate with parens 2012-10-18 12:46:08 -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

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.