Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update check method docs #18347

Merged
merged 3 commits into from
Oct 3, 2023
Merged

Update check method docs #18347

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
255bbf2
Add section on not using fail_with in check methods
bwatters-r7 Sep 6, 2023
48dcb24
Delete repeat
bwatters-r7 Sep 6, 2023
42f6bb8
Update on feedback from jmartin
bwatters-r7 Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/metasploit-framework.wiki/How-to-write-a-check-method.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ The `CheckCode` also supports an optional description which is printed by the fr
return CheckCode::Appears('Vulnerable component XYZ is installed')
```

Metasploit Framework check methods are used occasionally by other groups and projects to assist with vulnerability scanning. Please do your best to ensure that the only return value from a check method is a check code.
cgranleese-r7 marked this conversation as resolved.
Show resolved Hide resolved
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:
Expand Down