Files
metasploit-gs/documentation/modules/module_doc_template.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

45 lines
1.3 KiB
Markdown
Raw Normal View History

2020-02-18 10:55:13 -06:00
The following is the recommended format for module documentation. But feel free to add more content/sections to this.
2017-02-27 21:08:18 -05:00
One of the general ideas behind these documents is to help someone troubleshoot the module if it were to stop
functioning in 5+ years, so giving links or specific examples can be VERY helpful.
2016-02-26 14:30:12 -06:00
2020-02-21 09:30:34 -06:00
## Vulnerable Application
2016-02-26 14:18:24 -06:00
2020-04-24 06:42:49 -04:00
Instructions to get the vulnerable application. If applicable, include links to the vulnerable install
2020-04-23 12:11:25 -04:00
files, as well as instructions on installing/configuring the environment if it is different than a
standard install. Much of this will come from the PR, and can be copy/pasted.
2016-02-26 14:24:24 -06:00
2016-02-26 14:18:24 -06:00
## Verification Steps
Example steps in this format (is also in the PR):
2016-02-26 14:24:24 -06:00
1. Install the application
1. Start msfconsole
1. Do: `use [module path]`
1. Do: `run`
1. You should get a shell.
2020-04-23 12:11:25 -04:00
2016-02-26 14:18:24 -06:00
## Options
2020-04-23 12:11:25 -04:00
List each option and how to use it.
2016-02-26 14:18:24 -06:00
2020-02-18 10:55:13 -06:00
### Option Name
2016-02-26 14:24:24 -06:00
2020-04-24 06:42:49 -04:00
Talk about what it does, and how to use it appropriately. If the default value is likely to change, include the default value here.
2016-02-26 14:24:24 -06:00
2016-02-26 14:18:24 -06:00
## Scenarios
2020-02-18 10:55:13 -06:00
Specific demo of using the module that might be useful in a real world scenario.
2016-02-26 14:18:24 -06:00
2020-02-18 10:55:13 -06:00
### Version and OS
2016-02-26 14:24:24 -06:00
```
code or console output
```
2016-02-26 14:43:53 -06:00
For example:
2016-02-26 14:43:53 -06:00
To do this specific thing, here's how you do it:
2016-02-26 14:43:53 -06:00
```
msf > use module_name
msf auxiliary(module_name) > set POWERLEVEL >9000
msf auxiliary(module_name) > exploit
```