Skip to content

Commit 982401e

Browse files
authored
Land rapid7#19794, Add docs for Stance and Passive metadata
Add docs for Stance and Passive metadata
2 parents d84eb32 + 6d173c6 commit 982401e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/metasploit-framework.wiki/Get-Started-Writing-an-Exploit.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,11 @@ end
112112
* **Reliability** - The Reliability field describes how reliable the session is that gets returned by the exploit, ex: `REPEATABLE_SESSION`, `UNRELIABLE_SESSION`
113113
* **SideEffects** - The SideEffects field describes the side effects cause by the exploit that the user should be aware of, ex: `ARTIFACTS_ON_DISK`, `IOC_IN_LOGS`, `ACCOUNT_LOCKOUTS`.
114114

115+
### Non-required fields
116+
117+
* **Stance** - The types of stances an exploit can take, such as passive or aggressive. Stances indicate whether or not the module triggers the exploit without waiting for one or more conditions to be met (aggressive) or whether it must wait for certain conditions to be satisfied before the exploit can be initiated (passive). Passive exploits usually would wait for interaction from a client or other entity for being able to trigger the vulnerability.
118+
119+
* **Passive** - Either `true` or `false` indicates whether or not the exploit should be run as a background job. If for example you know the vulnerability takes an hour to trigger, setting `Passive` to `true` would be beneficial as it allows the user to continue using msfconsole while waiting for a response from the exploit.
115120

116121
Your exploit should also have a `check` method to support the check command, but this is optional in case it's not possible.
117122

0 commit comments

Comments
 (0)