mirror of https://github.com/rapid7/metasploit-framework synced 2024-10-29 18:07:27 +01:00

Go to file

Brendan Coles 6a29b87a4c Add pdf-reader dependency		2017-07-07 11:19:06 +00:00
.github	Add documentation requirement to PR template	2017-04-05 10:03:05 -04: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	Add docs, fix typo, add missing report mixin to avoid error.	2017-06-05 13:49:59 -05:00
db	Bump version of framework to 4.13.11	2017-01-04 14:53:33 -08:00
docker	git is no longer needed to build an image	2017-05-26 23:08:13 -05:00
documentation	Land #8577 , Add SurgeNews User Credentials scanner	2017-07-03 10:14:03 -05:00
external	add x64 stager_sock_reverse src	2017-06-25 16:31:37 +09:00
features	removing a newline	2017-01-10 14:08:51 -06:00
lib	pass loggger conditionally to common search function	2017-07-03 16:22:47 -05:00
modules	Add Gather PDF Authors auxiliary module	2017-07-06 23:29:17 +00:00
plugins	Land #8535 , MSGRPC module minor fixes	2017-06-15 21:44:34 -05:00
script	rails generate cucumber:install	2014-08-27 14:10:04 -05:00
scripts	fix usage on meterpreter script	2017-05-10 23:01:02 -05:00
spec	remove silly spec	2017-06-24 16:00:46 -05:00
test	Minor cleanups for multi-platform railgun	2017-04-25 17:45:07 -04:00
tools	revise spelling, add heartbleed and tidy checks	2017-06-28 18:50:20 -04:00
.dockerignore	more docker work	2017-04-22 02:10:00 +02:00
.gitignore	trying rspec-retry	2017-06-20 14:02:32 -05:00
.gitmodules	Add RDI submodule, port Kitrap0d	2013-11-27 16:04:41 +10:00
.mailmap	refine rageltman, add rwhitcroft	2016-12-22 00:58:58 -06: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	revert back to Ruby 2.4.1	2017-06-23 20:39:44 -05:00
.simplecov	Remove fastlib	2014-09-18 15:24:21 -05:00
.travis.yml	trying rspec-retry	2017-06-20 14:02:32 -05: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	Updated COPYING	2017-01-17 12:36:26 +10:00
docker-compose.yml	add timezone	2017-05-21 15:21:40 +02:00
Gemfile	trying rspec-retry	2017-06-20 14:02:32 -05:00
Gemfile.local.example	update Gemfile.local example, use Gemfile.local if it exists when bundling	2017-04-30 10:57:55 -05:00
Gemfile.lock	Add pdf-reader dependency	2017-07-07 11:19:06 +00:00
HACKING	Update link for The Metasploit Development Environment	2014-07-15 10:16:47 -05:00
LICENSE	move gem licenses to a separate auto-generated file	2017-04-07 11:49:58 -05:00
LICENSE_GEMS	update gem licenses	2017-05-26 23:20:04 -05:00
metasploit-framework.gemspec	Add pdf-reader dependency	2017-07-07 11:19:06 +00:00
msfconsole	Move service stub in x86 encoder to be easily used.	2016-06-23 14:56:03 +02: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	update specs	2017-05-27 00:34:12 -05:00
msfvenom	Removing unnecessary spaces	2017-05-04 10:41:02 -03:00
Rakefile	trying rspec-retry	2017-06-20 14:02:32 -05:00
README.md	Secure (https) links in README.md	2017-05-16 15:25:30 -04: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: https://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.