mssql_login documentation added. #18428
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
jheysel-r7
reviewed
Oct 12, 2023
There was a problem hiding this comment.
Thanks for the PR @AleksaZatezalo!! I've added a few suggestions around general formatting. I've also added a ### Setup section section under ## Vulnerable Application outlining how users can spin up a target to test this module.
One very useful tool when writing metasploit documentation is the tools/dev/msftidy_docs.rb. It can be run like so and provides important information with regards to formatting:
➜ metasploit-framework git:(1bd7d25088) ruby tools/dev/msftidy_docs.rb documentation/modules/auxiliary/scanner/mssql/mssql_login.md
documentation/modules/auxiliary/scanner/mssql/mssql_login.md - [WARNING] Please add a newline at the end of the file
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:3 - [WARNING] Spaces at EOL
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:6 - [WARNING] Instructional text not removed
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:9 - [WARNING] Should use single backquotes (`) for single line literals instead of triple backquotes (```)
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:10 - [WARNING] Should use single backquotes (`) for single line literals instead of triple backquotes (```)
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:11 - [WARNING] Should use single backquotes (`) for single line literals instead of triple backquotes (```)
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:15 - [WARNING] Spaces at EOL
documentation/modules/auxiliary/scanner/mssql/mssql_login.md:16 - [WARNING] Spaces at EOL
msftidy_docs.rb should always be run before submitting docs files. I've went ahead and applied the fixes to the above warnings.
jheysel-r7
reviewed
Oct 12, 2023
Release NotesThis PR adds documentation for the mssql_login module. |
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.
Working on auxilary scanner docs. Issue #12389. Added documentation for mssql_login.
Verification
Steps needed to make things work are as follows:
msfconsolemsf> use scanner/mssql/mssql_loginmsf> info -d