Writing Module Documentation

Adding and reviewing module documentation is a great way to contribute to the Metasploit Framework.

Before you write any module documentation, you should take a look at the sample template, module_doc_template.md, which is located in metasploit-framework/documentation/modules/markdown_doc, or take a look at any of the KBs that are already available.

Writing a KB

To write a KB, you'll need to:

• Create an markdown (.md) file.
• Write the content.
• Save the file and name it after the module name. For example, the filename for ms08-067 is modules/exploits/windows/smb/ms08_067_netapi.rb, so its documentation is documentation/modules/exploits/windows/smb/ms08_067_netapi.md.
• Place it in the metasploit-framework/documentation/modules directory.

Where to put the markdown files

If you go to metasploit-framework/documentation/modules, you'll see that there are documentation directories for each module type: auxiliary, exploit, payload, and post. To figure out where you need to put the file, you'll need to look at the module's path.

1. Start msfconsole.
2. Type use <module name>.
3. Type info.
4. When the module name appears, look at the Module field. You'll see a file path for the module. That's the path where the KB needs to be added.

For example:

msf> use auxiliary/scanner/smb/smb_login
msf (smb_login)> info

Name: SMB Login Check Scanner
Module: auxiliary/scanner/smb/smb_login
....

If you were creating a KB for the smb login scanner, you'd add it to metasploit-framework/documentation/modules/auxiliary/smb.md.

###Sections you should include in the KB

These are just suggestions, but it'd be nice if the KB had these sections:

• Vulnerable Applications - Tells users what targets are vulnerable to the module and provides instructions on how to access vulnerable targets for testing.
• Verification Steps - Tells users how to use the module and what the expected results are from running the module.
• Options - Provides descriptions of all the options that can be run with the module. Additionally, clearly identify the options that are required.
• Scenarios - Provides sample usage and describes caveats that the user may need to be aware of when running the module.