Files
metasploit-gs/documentation
Jack Heysel 603e5b2bff Land #18569, Add a module to perform ASREP-roasts
This adds a module to gather credential material from accounts
with Requires Pre-Authentication disabled. The module supports two
mechanisms, Brute Forcing using a list of usernames or using a LDAP
query to request the relevant usernames, followed by requesting TGTs.
2023-12-11 19:58:06 -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.