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…

Что это такое?Metasploit Framework — опенсорсный фреймворк для пентестов, написанный на Ruby. Это один из самых известных наборов инструментов по безопасности на GitHub, у него около 39 000 звёзд.
Это готовый инструмент или фреймворк, на котором мне придётся что-то строить самому?Это фреймворк, но чтобы им пользоваться, писать код не нужно: msfconsole — основной готовый интерфейс для работы с ним, а ещё есть API и документация, если захотите писать свои модули.
Как его установить?Возьмите официальный установщик для Linux или macOS на странице Nightly Installers — 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
Creator
rapid7
Size
1.2 GB
Stars
39.2K
Updated
CommitOct 16
Age
15y
Commits · 90 Days