Go to file
Spencer McIntyre df81cda304 Bump rex-socket to pull in validation changes 2024-02-14 09:39:51 -05:00
.github Temporarily remove PHP github action testing 2024-02-05 14:36:26 +00:00
app Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
config Fix bootsnap warning when booting msfrpc service 2023-08-02 17:35:11 +01:00
data Land #18633, WordPress Backup Migration Plugin PHP Filter Chain RCE (CVE-2023-6553) 2024-01-17 18:42:52 +01:00
db automatic module_metadata_base.json update 2024-02-08 07:04:19 -06:00
docker Replace grep with getent in entrypoint.sh 2023-10-18 15:38:21 +02:00
docs Update code formatting in Metasploit installation docs 2024-02-06 11:35:50 +01:00
documentation Land #18780, runc cwd priv esc (docker) (cve-2024-21626) 2024-02-05 13:12:02 +01:00
external Address comments from the review 2023-10-12 09:50:19 -04:00
kubernetes Meterpreter Helm chart tweaks 2021-11-05 15:14:19 +00:00
lib Validate hostnames before storing them 2024-02-09 14:52:41 -05:00
modules Land #18759, Updates MySQL modules to now support the new MySQL session type 2024-02-08 12:39:51 +00:00
plugins Land #18704, Leverage the module metadata cache in the module_sets 2024-02-02 14:16:46 +00:00
script Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
scripts fix spelling in scripts folder 2024-01-07 13:20:40 -05:00
spec Support multiple addresses for a static hostname 2024-02-08 16:05:54 -05:00
test Fix encoded payloads test 2024-01-16 13:31:51 +00:00
tools Land #18704, Leverage the module metadata cache in the module_sets 2024-02-02 14:16:46 +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 Ignore .solargraph.yml config file 2023-05-17 15:03:05 -05:00
.gitmodules
.mailmap Remove wvu from list at his request, and move past contributors to appropriate section 2023-01-05 09:13:51 -06:00
.rspec Add modern --require to .rspec 2014-10-08 10:55:40 -05:00
.rubocop.yml detect invalid Pack/Unpack directives 2023-08-03 17:39:21 +01:00
.ruby-gemset
.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
.solargraph.yml Removed lib include line as it became redundant 2023-05-16 23:02:55 -04: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 links within Wiki site to make them relative links where possible 2023-01-27 10:09:02 -06: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 updated Dockerfile for arm architectures 2023-12-08 16:43:40 +02:00
Gemfile Bump rex-socket to pull in validation changes 2024-02-14 09:39:51 -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 Bump rex-socket to pull in validation changes 2024-02-14 09:39:51 -05:00
LICENSE Land #18314, Windows Error Reporting RCE (CVE-2023-36874) 2023-09-27 15:25:06 +02:00
LICENSE_GEMS Bump version of framework to 6.3.56 2024-02-08 03:38:37 -06:00
README.md Remove references to Travis CI since we no longer use it and now use GitHub Actions 2023-01-17 10:28:21 -06: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
cortex.yaml PD-41096 Auto-add cortex.yaml 2023-10-02 14:13:52 +01: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 Land #18737, Update metasploit-payloads gem to 2.0.165 2024-01-25 15:49:25 +01:00
msf-json-rpc.ru Fix bootsnap warning when booting msfrpc service 2023-08-02 17:35:11 +01:00
msf-ws.ru Fix bootsnap warning when booting msfrpc service 2023-08-02 17:35:11 +01:00
msfconsole Add support for ruby 3.3.0-preview2 2023-10-13 01:41:10 +01:00
msfd remove `msf` folder requires 2021-01-18 14:21:54 +00:00
msfdb Land #18440, Add remote webservice deletion notice 2023-11-10 10:24:34 +00: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 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.