Go to file
Spencer McIntyre 2e3a2b6f6d Combine AWS SSM modules, autodetect platform 2023-04-19 18:05:50 -04:00
.github Land #17161, Bump actions/checkout to version 3.x 2022-10-20 11:02:35 +01:00
app deprecated model error pattern 2021-08-09 12:16:12 -05:00
config Update reline and suppress Fiddle issue 2022-09-01 11:05:54 -05:00
data Land #17272, Add F5 MCP post module 2022-12-12 14:20:31 -05:00
db automatic module_metadata_base.json update 2022-12-12 17:09:12 -06:00
docker remove debug output 2018-10-21 22:34:19 +02:00
docs Update docs site to support mermaid 2022-12-11 01:22:30 +00:00
documentation Land #17272, Add F5 MCP post module 2022-12-12 14:20:31 -05:00
external review 2022-11-22 16:57:01 -05:00
kubernetes Meterpreter Helm chart tweaks 2021-11-05 15:14:19 +00:00
lib Combine AWS SSM modules, autodetect platform 2023-04-19 18:05:50 -04:00
modules Combine AWS SSM modules, autodetect platform 2023-04-19 18:05:50 -04:00
plugins consolidate the config directory lookups 2022-07-25 15:27:21 -05:00
script kill cucumber in framework 2017-07-12 08:00:29 -05:00
scripts Land #16930, dev_checks: Add additional checks 2022-09-15 10:50:00 -04:00
spec Land #17214, add database functionality to vcenter post module 2022-12-05 12:50:14 -06:00
test Test and handle REG_QWORD 2022-09-20 16:31:54 -04:00
tools Fix crash when generating payload sizes 2022-11-04 02:10:58 +00:00
.dockerignore change docker root exec 2018-10-21 22:30:01 +02:00
.git-blame-ignore-revs Update git-blame-ignore-revs to ignore tabs to spaces commits 2022-05-04 13:15:53 +01:00
.gitignore Add in Visual Studio Code .vscode directory to .gitignore 2022-08-31 19:44:49 -05:00
.gitmodules Add RDI submodule, port Kitrap0d 2013-11-27 16:04:41 +10:00
.mailmap Add Simon Janusz to mail map 2021-07-13 10:38:50 +01:00
.rspec Add modern --require to .rspec 2014-10-08 10:55:40 -05:00
.rubocop.yml Update rubocop rules for test modules 2022-04-28 14:11:26 +01:00
.ruby-gemset Remove gitignore, change to metasploit-framework 2013-09-13 12:44:19 -05:00
.ruby-version Update Ruby version to 3.0.5 from 3.0.2 to fix security issues and compatibility 2022-12-08 13:58:46 -06:00
.simplecov Remove fastlib 2014-09-18 15:24:21 -05:00
.yardopts remove HACKING from yardopts 2017-09-07 02:35:56 -05:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2022-10-29 15:56:49 +01:00
CONTRIBUTING.md Fix up a typo in CONTRIBUTING.md 2021-06-05 14:31:15 -05:00
COPYING Update LICENSE and COPYING 2020-01-18 18:45:37 -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 Update Ruby version in Dockerfile 2022-12-08 14:59:58 -06:00
Gemfile Add in ruby/debug to Gemfile and also provide example of how to create a launch.json file to use it with vscode-rdbg 2022-09-01 13:35:08 -05:00
Gemfile.local.example Add in fix to use relative paths for Gemfile.local.example, thereby fixing review comments 2020-09-24 09:25:03 -05:00
Gemfile.lock add aws ssm gem to lock file 2023-01-13 09:59:05 -05:00
LICENSE Add compiler support when mingw is available 2022-09-15 16:06:25 -04:00
LICENSE_GEMS Bump version of framework to 6.2.31 2022-12-08 12:12:22 -06:00
README.md Update README.md to modernize the links to point to the new docs.metasploit.com website, remove links that weren't being used, and improve explanations in some locations 2022-09-16 11:22:44 -05:00
Rakefile Use zeitwerk for lib/msf/core folder 2020-12-07 10:31:45 +00:00
Vagrantfile moves v.gui comment to appropriate location(s) 2020-10-08 11:59:09 -05:00
docker-compose.override.yml change docker root exec 2018-10-21 22:30:01 +02:00
docker-compose.yml docker: hassle-free DB bootstrap 2021-01-08 16:20:11 +01:00
metasploit-framework.gemspec Initial implementation for AWS SSM shells 2022-12-31 15:04:27 -05:00
msf-json-rpc.ru Add health check functionality 2021-04-16 01:59:22 +01:00
msf-ws.ru Use zeitwerk for lib/msf/core folder 2020-12-07 10:31:45 +00:00
msfconsole move web service api code into library path 2021-08-09 12:22:43 -05:00
msfd remove `msf` folder requires 2021-01-18 14:21:54 +00:00
msfdb Land #16094, Fix msfdb init command failure in systems that use the 'pg_ctl.rb' msfdb helper 2022-07-27 12:15:37 -05:00
msfrpc Remove extra `require` for a now deleted file that no longer exists 2021-03-02 10:57:07 +00:00
msfrpcd consolidate the config directory lookups 2022-07-25 15:27:21 -05:00
msfupdate we don't need ruby-backports anymore (or maybe we can use it more conditionally on Ruby 2.6), it uses a lot of memory 2019-12-02 09:03:58 -06:00
msfvenom Generate machine readable msfvenom output when pipes are used 2021-05-26 11:13:49 +01:00

README.md

Metasploit Build Status Maintainability Test Coverage 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://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html

You can find documentation on Metasploit and how to use it at: https://docs.metasploit.com/

Information about setting up a development environment can be found at: https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html

Our bug and feature request tracker can be found at: https://github.com/rapid7/metasploit-framework/issues

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://docs.metasploit.com/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 take a look at the Using Metasploit page on the documentation website.

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.