1
mirror of https://github.com/rapid7/metasploit-framework synced 2024-10-29 18:07:27 +01:00
Go to file
2023-08-21 19:20:25 -04:00
.github Remove Ruby 2.7 from Github actions 2023-06-30 14:10:07 +01:00
app Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
config Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
data Responded to comments, improved stability 2023-08-21 19:20:25 -04:00
db automatic module_metadata_base.json update 2023-07-21 06:15:43 -05:00
docker Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
docs Add syntax highlighting to multiple code snippets 2023-07-14 11:52:47 +01:00
documentation General code clean up 2023-08-04 14:27:14 -04:00
external Responded to comments, improved stability 2023-08-21 19:20:25 -04:00
kubernetes Meterpreter Helm chart tweaks 2021-11-05 15:14:19 +00:00
lib Land #18187, Fixes incorrect usage of pack/unpack directives 2023-07-21 11:40:02 +01:00
modules Responded to comments, improved stability 2023-08-21 19:20:25 -04:00
plugins Add centralized Metasploit plugin documentation 2023-07-06 19:00:33 +01:00
script Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
scripts Move folder descriptions into README.md files 2023-05-03 14:06:13 -05:00
spec Tidy up plugin specs 2023-07-07 17:14:29 +02:00
test Land #18127, Add railgun reverse lookup tests for osx and linux 2023-06-20 14:27:29 +01:00
tools Move folder descriptions into README.md files 2023-05-03 14:06:13 -05: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 Add RDI submodule, port Kitrap0d 2013-11-27 16:04:41 +10:00
.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 Set Lint/UnusedMethodArgument rule to apply to everything but lib/ folder 2023-04-12 11:31:28 -05: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
.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
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
Dockerfile Update Ruby version in Dockerfile 2022-12-08 14:59:58 -06:00
Gemfile Remove lock on Pry version since Ruby 2.6 is no longer supported by Metasploit and so this no longer applies 2023-01-05 18:55:39 -06: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 version of framework to 6.3.27 2023-07-20 12:14:17 -05:00
LICENSE Update external modules to support python 3.11 2023-03-21 11:00:56 +00:00
LICENSE_GEMS Bump version of framework to 6.3.27 2023-07-20 12:14:17 -05:00
metasploit-framework.gemspec Update PHP Meterpreter to correctly show file sizes for large files 2023-06-30 10:22:13 +01: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 Improve accuracy of msfconsole performance profiling 2023-03-07 12:41:07 +00:00
msfd remove msf folder requires 2021-01-18 14:21:54 +00:00
msfdb Updates the msfdb prompts for webservice 2023-05-19 12:57:35 +01: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
Rakefile Use zeitwerk for lib/msf/core folder 2020-12-07 10:31:45 +00: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
Vagrantfile moves v.gui comment to appropriate location(s) 2020-10-08 11:59:09 -05:00

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.