Metasploit Framework
Ruby JavaScript Python C PowerShell Assembly Other
Failed to load latest commit information.
.github Add documentation requirement to PR template Apr 5, 2017
app Move shared example from pro into framework Apr 7, 2016
config Land #6556, include Vagrant development environment provisioner Jun 9, 2016
data Land #9422 abrt race condition priv esc on linux Feb 11, 2018
db First pass at changes needed for module metadata caching Nov 15, 2017
docker more docker work Nov 28, 2017
documentation Land #9512, Add Claymore Dual GPU Miner<= 10.5 DoS module Feb 16, 2018
external apple_ios/aarch64/shell_reverse_tcp Dec 19, 2017
lib properly handle when there is no stat callback specified on upload Feb 16, 2018
modules specify a python encoding for the module Feb 16, 2018
plugins remove more instances of positive? Aug 2, 2017
script kill cucumber in framework Jul 12, 2017
scripts s/imporve/improve/g Feb 13, 2018
spec add missing payload tests for bind_named_pipe Feb 17, 2018
test add initial module automation tests Dec 5, 2017
tools remove more checks Jan 22, 2018
.dockerignore more docker work Nov 28, 2017
.gitignore Land #9220, Module cache improvements Jan 18, 2018
.gitmodules Add RDI submodule, port Kitrap0d Nov 27, 2013
.mailmap Add mkienow to the mailmap Jan 7, 2018
.rspec Add modern --require to .rspec Oct 8, 2014
.rubocop.yml disable redundant return warning, update a couple others Aug 14, 2017
.ruby-gemset Restoring ruby and gemset files May 20, 2014
.ruby-version bump travis and rvm ruby versions Jan 28, 2018
.simplecov Remove fastlib Sep 18, 2014
.travis.yml bump travis and rvm ruby versions Jan 28, 2018
.yardopts remove HACKING from yardopts Sep 7, 2017 Add individual contacts Jan 13, 2016 Fix small grammar issues in ms08_067 and ms17_010 Jan 16, 2018
COPYING Update COPYING Jan 9, 2018 add to track major changes and how to migrate with them Jan 18, 2018
Dockerfile update dockerfile to include newer Jan 28, 2018
Gemfile restrict aggregator on arm for now Oct 18, 2017
Gemfile.local.example update Gemfile.local example, use Gemfile.local if it exists when bun… Apr 30, 2017
Gemfile.lock bump payloads, include bind_named_pipe support Feb 15, 2018
LICENSE Vendor async_timeout Jan 23, 2018
LICENSE_GEMS Update rex-exploitation to 0.1.15 Oct 11, 2017 add docker pull badge to readme Dec 6, 2017
Rakefile trying rspec-retry Jun 20, 2017
Vagrantfile fix #8693, update Vagrant to latest rvm syntax Jul 11, 2017
docker-compose.override.yml more docker work Nov 28, 2017
docker-compose.yml more docker work Nov 28, 2017
metasploit-framework.gemspec bump payloads, include bind_named_pipe support Feb 15, 2018
msfconsole Move service stub in x86 encoder to be easily used. Jun 23, 2016
msfd Removing unnecessary spaces Sep 12, 2017
msfrpc Removing unnecessary spaces Sep 12, 2017
msfrpcd Removing unnecessary spaces Sep 12, 2017
msfupdate update specs May 27, 2017
msfvenom Removing unnecessary spaces Sep 12, 2017

Metasploit Build Status Code Climate Docker Pulls

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

The latest version of this software is available from:

Bug tracking and development information can be found at:

New bugs and feature requests should be directed to:

API documentation for writing modules can be found at:

Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list


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.


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.