Add the DB_SKIP_EXISTING option to the AuthBrute mixin #15630
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note to self: the Creating Metasploit Framework LoginScanners and How to write a HTTP LoginScanner pages should be updated to callout the new mixin method is the preferred way to initialize the |
zeroSteiner
commented
Sep 1, 2021
bwatters-r7
reviewed
Sep 2, 2021
bwatters-r7
reviewed
Sep 2, 2021
This updates existing modules that use the AuthBrute mixin to use the new build_credential_collection API to consistently handle the new option.
These module should be using the PrivateCredentialCollection.
zeroSteiner
force-pushed
the
feat/db-skip
branch
from
9f296a3
to
e2beff1
Compare
|
Awesome job on this @smcintyre-r7. Great refactor, this cleans up a lot of copy and pasted code. I've tested the Auth Brute mixin against the three modules suggested in the description and they seem to be working as expected:
@smcintyre-r7 Gentle reminder about this comment: |
|
I'll update the docs as described in that comment after PR has been landed and everything's finalized. That way if there are any changes that need to be made I can just write the docs once 😄 . |
Release NotesThis adds the option DB_SKIP_EXISTING to the AuthBrute mixin to give users the option to skip credentials already in the database when preforming brute force attacks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the
PrivateCredentialCollectionclass to allow a filter callback to be defined on it. It needs to be a callback, because theCredentialCollectioninstance is often passed to another object that will blindly iterate over it. The other object (like a login scanner) should be unaware of the filter. TheAuthBrutemixin is then updated to create theCredentialCollectionusing the newbuild_credential_collectionmethod which will check the datastore options set the filter as appropriate.Prior to this, all of the modules using the
AuthBrutemixin were building theirCredentialCollectioninstances themselves which created alot of redundant copy-pasta code. It also meant that it was up to the options to honor theDB_ALL_*datastore options that they had defined by including theAuthBrutemixin. This lead to quite a few modules that appear to have been ignoring the options. All of the modules have been migrated to use the new mixin method. A few that were only brute-forcing passwords before thePrivateCredentialCollectionwas created were switched to using that. Modules that are using thePrivateCredentialCollectionprobably don't make sense to be filtered since there is no username field to filter on in the same way.The new
DB_SKIP_EXISTINGoption is an enum so it can be extended with other conditions in the future. Right now three are defined:none- Don't perform any filtering. This is the default value and retains the existing behavior.user- Filter out credentials when the username can be found in the database. This ignores therealmfield.user&realm- Filter out credentials when the username and realm match a single object in the database.Verification
USERNAME,SMBUserandHttpUsername. Need to make sure these didn't change.auxiliary/scanner/ssh/ssh_loginauxiliary/scanner/smb/smb_loginauxiliary/scanner/http/http_logincreds -d)DB_SKIP_EXISTINGset touserVERBOSEtotrueto see each individual attempt.DB_SKIP_EXISTINGset touser&realm. See the expected results depending on the module. It will probably filter out the user, but it depends.Example
In the following example, all three
DB_SKIP_EXISTINGcases are shown using theauxiliary/scanner/ssh/ssh_loginmodule. The smcintyre user has a realm defined. Thessh_loginmodule does not define a realm so when the filtering is set touser&realmthe smcintyre user is included because the realm the module is using is nil.