diff --git a/docs/metasploit-framework.wiki/How-to-write-a-check-method.md b/docs/metasploit-framework.wiki/How-to-write-a-check-method.md index 4f2af0e630fe..3af8c661c9ba 100644 --- a/docs/metasploit-framework.wiki/How-to-write-a-check-method.md +++ b/docs/metasploit-framework.wiki/How-to-write-a-check-method.md @@ -37,6 +37,10 @@ The `CheckCode` also supports an optional description which is printed by the fr return CheckCode::Appears('Vulnerable component XYZ is installed') ``` +`MetasploitModule#check` methods should capture any known `raise` from methods called and return value of class +`Msf::Exploit::CheckCode`. Basically, that means avoiding the use of `fail_with` or raising exceptions that are not +handled within the check method. + ## Remote Check Example Here's an abstract example of how a Metasploit check might be written: