metasploit-framework README

The project's README from github.com/rapid7/metasploit-framework. As one markdown file: README.md.

Metasploit Framework

The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to the COPYING file.

Latest Version

Access the latest version of Metasploit from the Nightly Installers page.

Documentation

Comprehensive documentation, including usage guides, is available at Metasploit Docs.

Development Environment

To set up a development environment, visit the Development Setup Guide.

Bug and Feature Requests

Submit bugs and feature requests via the GitHub Issues tracker. New submissions can be made through the MSF-BUGv1 form.

API Documentation

For information on writing modules, refer to the API Documentation.

Support and Communication

For questions and suggestions, you can:

Note: Some community members may still use IRC channels and the metasploit-hackers mailing list, though the primary support channels are now GitHub Discussions and Slack.

Installing Metasploit

We recommend installation with the official Metasploit installers on Linux or macOS. Metasploit is also pre-installed with Kali.

For a manual setup, consult the Dev Environment Setup guide.

Using Metasploit

To get started with Metasploit:

  1. Start msfconsole: This is the primary interface for interacting with Metasploit.
  2. Explore Resources:

Contributing

To contribute to Metasploit:

  1. Setup Development Environment: Follow the instructions in the Development Setup Guide on GitHub.
  2. Clone the Repository: Obtain the source code from the official repository.
  3. Submit a Pull Request: After making changes, submit a pull request for review. Additional details can be found in the Contributing Guide.

metasploit-framework (rapid7/metasploit-framework)

Searching Database…

39.2K ·GitHub
Metasploit-framework
这是干什么的?Metasploit Framework 是一个用 Ruby 编写的开源渗透测试框架,是 GitHub 上最知名的安全工具之一,拥有约 39,000 颗星。
它是一个拿来就能用的工具,还是需要我在上面做二次开发的框架?它是一个框架,但使用它并不需要写代码:msfconsole 是主要的、拿来就能用的操作界面,另外还提供 API 层和文档,方便你编写自己的模块。
我怎么把它装起来?从 Nightly Installers 页面下载适用于 Linux 或 macOS 的官方安装包——Metasploit 在 Kali 上也是预装的。如果想手动安装或搭建开发环境,可以参考 Dev Environment Setup 指南。
它能在 Windows 上运行吗,还是只支持 Linux 和 macOS?README 只提供了 Linux 和 macOS 的安装包(以及预装好的 Kali 版本),没有提到 Windows 安装包,所以最好准备一个类 Unix 系统。
它的授权条款清楚简单吗?大体上是的:README 称它采用开源的 BSD 风格许可证,但具体条款并没有在那里写明——它让你去查看 COPYING 文件,而 GitHub 上该许可证被列为未分类。
我能自己编写漏洞利用模块吗?可以——模块开发是一等公民的使用场景:README 引导模块作者查看 API Documentation,代码贡献则走标准的开发环境搭建、克隆仓库和提交 pull request 的流程。这个框架本身就是用 Ruby 写的。
如果我不想直接装在系统里,有没有 Docker 方案?有——仓库自带 Dockerfile 和 docker-compose 配置,你可以用容器来运行 Metasploit,而不必直接装到宿主机上。
这个项目还在积极维护吗?是的——该仓库没有被归档,拥有约 39,000 颗星,并且运行着多条 CI 工作流,包括验收测试和文档构建。
What are similar projects?beef, Decepticon, masscan, redamon, Cybermes, ffuf, nikto, hacker-roadmap
Which topics is it in?kali-linux, exploitation, api-documentation, infosec, hacking-tool, offensive-security, ruby, pentesting, penetration-testing, real-time, cybersecurity, security-tools
Creator
rapid7
Size
1.2 GB
Stars
39.2K
Updated
CommitOct 16
Age
15y
Commits · 90 Days