mirror of https://github.com/rapid7/metasploit-framework synced 2024-11-05 14:57:30 +01:00

Go to file

Brent Cook 52d0840a79 Land #7276 , fix clipboard tlv usage		2016-09-22 00:47:18 -05:00
.github	Fix link	2016-02-22 15:14:38 -06:00
app	Move shared example from pro into framework	2016-04-07 13:09:52 -05:00
config	Land #6556 , include Vagrant development environment provisioner	2016-06-09 09:55:37 -05:00
data	diffed with fuzzdb	2016-09-21 00:20:46 -04:00
db	still trying to fix these migrations	2016-05-11 14:54:40 -05:00
documentation	Land #7266 , Add Kaltura Remote PHP Code Execution	2016-09-21 17:14:49 -05:00
external	add exploit for cve-2016-0189	2016-08-01 13:26:35 -05:00
features	Apparently the tests expected the typo in DATABASE.	2016-07-28 17:40:37 -05:00
lib	Land #7276 , fix clipboard tlv usage	2016-09-22 00:47:18 -05:00
modules	Land #7339 , SSH module fixes from net:ssh updates	2016-09-22 00:27:32 -05:00
plugins	Fix #7267 , Fix Wrong IDs on openvas plugin	2016-09-10 09:37:49 +09:00
script	rails generate cucumber:install	2014-08-27 14:10:04 -05:00
scripts	typo	2016-08-13 08:22:41 -05:00
spec	remove osvdb links	2016-09-20 14:27:59 -05:00
test	replace old rex::ui::text::table refs	2016-08-10 13:30:09 -05:00
tools	remove more refs	2016-09-20 14:31:28 -05:00
.gitignore	Merge branch 'master' into vagrant	2016-02-20 09:10:17 -07:00
.gitmodules	Add RDI submodule, port Kitrap0d	2013-11-27 16:04:41 +10:00
.mailmap	And Thao, too!	2016-07-01 16:10:21 -04:00
.rspec	Add modern --require to .rspec	2014-10-08 10:55:40 -05:00
.rubocop.yml	Reapply PR #4113 (removed via #4175 )	2014-11-11 15:06:43 -06:00
.ruby-gemset	Restoring ruby and gemset files	2014-05-20 10:17:00 -05:00
.ruby-version	bump ruby version to 2.3.1	2016-05-03 06:23:15 +02:00
.simplecov	Remove fastlib	2014-09-18 15:24:21 -05:00
.travis.yml	bump ruby version to 2.3.1	2016-05-03 06:23:15 +02:00
.yardopts	update .yardopts	2014-07-24 13:59:04 -05:00
CODE_OF_CONDUCT.md	Add individual contacts	2016-01-13 10:35:39 -06:00
CONTRIBUTING.md	Add note about release notes to CONTRIBUTING.md	2016-08-22 15:15:22 -05:00
COPYING	Update COPYING, too.	2016-01-04 16:31:01 -06:00
Gemfile	fix deps	2016-05-13 13:34:18 -05:00
Gemfile.local.example	Fix example Gemfile.local to work with existing	2014-06-24 00:00:47 -05:00
Gemfile.lock	Land #7316 , use new rex-encoder gem	2016-09-19 11:59:21 -05:00
HACKING	Update link for The Metasploit Development Environment	2014-07-15 10:16:47 -05:00
LICENSE	Update copyright notice to 2016 [ci skip]	2016-01-03 20:25:47 +05:30
metasploit-framework.gemspec	use new rex-encoder gem	2016-09-14 12:07:26 -05:00
msfconsole	Use Rex::Compat.open_file to open profiling report	2014-09-19 11:13:28 -05:00
msfd	Initialize the DisableBanner option	2015-10-08 14:08:45 -05:00
msfrpc	Change {} back to do/end	2015-03-09 00:00:49 -05:00
msfrpcd	allow overriding the default timeout for a session	2015-05-01 15:04:55 -05:00
msfupdate	File.exists? must die	2016-04-21 00:47:07 -04:00
msfvenom	Sort msfvenom --help-platforms	2016-08-25 14:02:58 -05:00
Rakefile	Merge branch 'feature/MSP-11130/metasploit-framework-spec-constants' into feature/MSP-11147/thread-leak-detection	2014-11-05 15:47:59 -06:00
README.md	Use SVG badges to please the eyes 👀	2015-12-13 00:28:14 +01:00
Vagrantfile	switch to inline provisioning, use official ubuntu vagrant box	2016-06-09 09:50:15 -05:00

README.md

Metasploit

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

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

Bug tracking and development information can be found at: https://github.com/rapid7/metasploit-framework

New bugs and feature requests should be directed to: http://r-7.co/MSF-BUGv1

API documentation for writing modules can be found at: https://rapid7.github.io/metasploit-framework/api

Questions and suggestions can be sent to: https://lists.sourceforge.net/lists/listinfo/metasploit-hackers

Installing

Generally, you should use the free installer, which contains all of the 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 Metasploit Unleashed, the great community resources, or the wiki.

Contributing

See the Dev Environment Setup guide on GitHub, which will walk you through the whole process from installing all the dependencies, to cloning the repository, and finally to submitting a pull request. For slightly more information, see Contributing.