metasploit-framework

https://github.com/rapid7/metasploit-framework

Ruby

Metasploit Framework

Msf::Auxiliary#autofilter

Performs last-minute sanity checking of auxiliary parameters. This method
is called during automated exploitation attempts and allows an
auxiliary module to filter bad attempts, obtain more information, and choose
better parameters based on the available data. Returning anything that
evaluates to "false" will cause this specific auxiliary attempt to
be skipped. This method can and will change datastore values and
may interact with the backend database. The default value for auxiliary
modules is false, since not all auxiliary modules actually attempt
to exploit a vulnerability.

Source | Google | Stack overflow

Edit

git clone [email protected]:rapid7/metasploit-framework.git

cd metasploit-framework

open lib/msf/core/auxiliary.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Msf--Auxiliary-autofilter-for-pr

# Commit to git

git add lib/msf/core/auxiliary.rbgit commit -m "better docs for Msf::Auxiliary#autofilter"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Msf--Auxiliary-autofilter-for-pr

hub pull-request

# Celebrate!