Metasploit Framework
 
 
 
 
 
 
Go to file
James Barnett dfbff53e10
Update LICENSE file to include swagger-ui API docs
2018-05-29 12:31:35 -05: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 correct filename for `/etc/group` 2018-05-22 00:12:20 +12:00
db automatic module_metadata_base.pstore update 2018-05-25 01:11:33 -07:00
docker another approach 2018-02-17 20:12:35 +01:00
documentation Address code review comments 2018-05-29 12:24:53 -05:00
external Land #8795, Added CVE-2016-0040 Windows Privilege Escalation 2018-05-03 16:33:53 -05:00
lib Address code review comments 2018-05-29 12:24:53 -05:00
modules fix incorrect disclosure date 2018-05-25 02:59:08 -05:00
plugins Land #10024, Fix find_or_create_* methods for remote data service 2018-05-22 17:08:46 -05:00
script kill cucumber in framework 2017-07-12 08:00:29 -05:00
scripts Fixed Typos 2018-02-28 03:37:14 +05:30
spec Land #10024, Fix find_or_create_* methods for remote data service 2018-05-22 17:08:46 -05:00
test Land #9246, Support RHOSTS for exploit modules 2018-05-16 14:40:25 -05:00
tools refresh standalone psexec a bit 2018-05-07 00:24:38 -05:00
.dockerignore Fix docker build 2018-03-06 14:16:39 +01:00
.gitignore Land #9220, Module cache improvements 2018-01-17 22:34:51 -06:00
.gitmodules Add RDI submodule, port Kitrap0d 2013-11-27 16:04:41 +10:00
.mailmap Add mkienow to the mailmap 2018-01-07 18:00:21 -05:00
.rspec Add modern --require to .rspec 2014-10-08 10:55:40 -05:00
.rubocop.yml Land #9986, initial ruby_smb simple client integration 2018-05-07 14:02:22 -05:00
.ruby-gemset Remove gitignore, change to metasploit-framework 2013-09-13 12:44:19 -05:00
.ruby-version bump to ruby 2.5.1 2018-03-30 12:47:19 +02:00
.simplecov Remove fastlib 2014-09-18 15:24:21 -05:00
.travis.yml Update .travis.yml 2018-05-07 10:50:10 -05:00
.yardopts remove HACKING from yardopts 2017-09-07 02:35:56 -05:00
CODE_OF_CONDUCT.md Add individual contacts 2016-01-13 10:35:39 -06:00
CONTRIBUTING.md include example of why PRs from master are bad 2018-05-08 17:54:14 -05:00
COPYING Update COPYING 2018-01-09 00:01:35 -06:00
CURRENT.md add CURRENT.md to track major changes and how to migrate with them 2018-01-18 06:35:53 -06:00
Dockerfile bump to ruby 2.5.1 2018-03-30 12:47:19 +02:00
Gemfile Require swagger-blocks in dev and test 2018-05-23 12:23:43 -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 Merge branch 'master' into local_api_docs 2018-05-29 10:37:27 -05:00
LICENSE Update LICENSE file to include swagger-ui API docs 2018-05-29 12:31:35 -05:00
LICENSE_GEMS Update rex-text to 0.2.17 2018-04-08 02:35:15 -05:00
README.md add docker pull badge to readme 2017-12-06 20:34:40 +01:00
Rakefile trying rspec-retry 2017-06-20 14:02:32 -05:00
Vagrantfile fix #8693, update Vagrant to latest rvm syntax 2017-07-10 21:41:50 -05:00
docker-compose.override.yml more docker work 2017-11-28 21:35:20 +01:00
docker-compose.yml more docker work 2017-11-28 21:35:20 +01:00
metasploit-framework.gemspec update kiwi plugin, add dcshadow and powershell streaming support 2018-05-21 03:22:05 -05:00
msfconsole Improved CTRL-C edge case, Invalid Options edge case, help output, version output 2018-03-20 13:34:15 -05:00
msfd Removing unnecessary spaces 2017-09-12 10:00:18 -03:00
msfdb_ws key file isnt always necessary, but cert is. 2018-02-05 15:23:00 -06:00
msfrpc Removing unnecessary spaces 2017-09-12 10:00:18 -03:00
msfrpcd Removing unnecessary spaces 2017-09-12 10:00:18 -03:00
msfupdate remove "require 'os'", not needed or available 2018-05-14 01:16:55 -05:00
msfvenom Land #9869, Add support for shellcode encryption for msfvenom 2018-04-25 15:51:05 -05:00

README.md

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: 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: Freenode IRC channel or e-mail the metasploit-hackers mailing list

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.