Update function docs #114
Update function docs #114
Conversation
|
Issue #115 supports this. |
SamErde
added
documentation
Made the synopsis consistent with other Find-ESC functions. Moved the details to the description.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Made the synopsis consistent with other Find-ESC synopsis by specifying which vulnerability it is checking for. ("This script finds AD CS (Active Directory Certificate Services) objects that have the ESC5 vulnerability.")
🦙 MegaLinter status:
|
| Descriptor | Linter | Files | Fixed | Errors | Elapsed time |
|---|---|---|---|---|---|
| jscpd | yes | 19 | 1.97s | ||
| editorconfig-checker | 23 | 1 | 0.37s | ||
| markdownlint | 1 | 11 | 0.84s | ||
| markdown-link-check | 1 | 9 | 3.06s | ||
| ✅ MARKDOWN | markdown-table-formatter | 1 | 0 | 0.42s | |
| powershell | 22 | 15 | 29.6s | ||
| ✅ POWERSHELL | powershell_formatter | 22 | 0 | 19.94s | |
| checkov | yes | 1 | 11.24s | ||
| ✅ REPOSITORY | gitleaks | yes | no | 0.36s | |
| ✅ REPOSITORY | git_diff | yes | no | 0.0s | |
| ✅ REPOSITORY | grype | yes | no | 13.62s | |
| ✅ REPOSITORY | secretlint | yes | no | 0.79s | |
| ✅ REPOSITORY | trivy | yes | no | 5.69s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | 2.7s | |
| ✅ REPOSITORY | trufflehog | yes | no | 8.09s | |
| cspell | 24 | 154 | 4.9s |
See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff
MegaLinter is graciously provided by
A nitpick, but CGPT used lowercase "$issue" in the examples while it is titlecase "$Issue" everywhere else.
Made indentation consistent with other CBH blocks.
Made indentation consistent with other CBH blocks.
Removed prompt characters from example code.
Removed '.ps1' from the example function.
Consistent indentation in CBH.
Removed prompt characters from examples.
There was a problem hiding this comment.
Several of the functions had redundant CmdletBinding and param () blocks added in this PR and need to be removed carefully.
Style question: what is a good way that we can distinguish commands, their output, and the description text for example blocks? I do like the way that most seem to have a blank link between the example command and the example description. Others have no distinguishing paragraph breaks between the example, the example output, and the description.
Private/Find-ESC8.ps1
Outdated
There was a problem hiding this comment.
Do you want to align the ESC8 synopsis with the prior ones ("This script finds AD CS (Active Directory Certificate Services) objects that have the ESC8 vulnerability.") or is this one a unique case given the different types of checks that could be performed?
Removed! If they are all gone to your satisfaction, please to be approving.
We can talk about this in Friday's meeting and decide on a standard. And if there's a definite style guide we want to follow, pls lmk! |
Removed extra lines at beginning. Indents in CBH. Blank line at EOF.
Removed '.ps1' from example.
Indentation
Used Copilot to add comment-based help to everything. It's not the best, but it's better than nothing!