Files
metasploit-gs/documentation
Jack Heysel 8cddffa3d1 Land #18700, Add Kafka-ui Unauth RCE module
This PR adds an exploit module for CVE-2023-52251 which
is an unauthenticated rce vulnerability in Kafka's UI.
2024-02-16 15:38:52 -05:00
..

Folder Purpose

This folder is primarily used to hold documentation for Metasploit's various modules, as well as the developers guide at developers_guide.pdf.

Metasploit Developer Documentation

Metasploit is actively supported by a community of hundreds of contributors and thousands of users world-wide. As a result, the accompanying documentation moves quite quickly.

The best source of documentation on Metasploit development is https://docs.metasploit.com/. There are many treasures there, such as:

...and many, many more.

API Documentation

If you are looking for API documentation, you may run rake yard to generate a navigable view of the comment documentation used throughout Metasploit, or visit https://rapid7.github.io/metasploit-framework/api for a recently generated online version.

Contributing

If you would like to contribute to the documentation effort, please see http://yardoc.org/ for details on how to write YARD-compatible comments, and send us a Pull Request with your contribution.