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.

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

Add exploiters reference #4211

Closed
10 tasks
mssalvatore opened this issue Jun 20, 2024 · 0 comments · Fixed by #4231
Closed
10 tasks

Add exploiters reference #4211

mssalvatore opened this issue Jun 20, 2024 · 0 comments · Fixed by #4231
Assignees
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.

Comments

@mssalvatore
Copy link
Collaborator

Edit existing documentation 📝

Page to edit

/reference/exploiters/*

Required changes

Use jsonschema2md to generate markdown documentation about each exploiter's configuration options. Note that some elements from the markdown will need to be manually removed (see /reference/payloads/ransomware and /reference/payloads/cryptojacker for an example). You can use the script shown below under "Resources" to dump the plugin's Pydantic options model to JSON.

In addition to configuration options, add any other Reference material that may be applicable (see /reference/payloads/ransomware for an example).

Pages

  • Hadoop
  • Log4Shell
  • MSSQL
  • PowerShell
  • RDP
  • SMBExec
  • SNMP
  • SSH
  • WMIExec
  • Zerologon

Resources

jsonschema2md
Diátaxis

import json
from src.<PLUGIN>_options import <PLUGIN>Options

print(json.dumps(<PLUGIN>Options.model_json_schema(), indent=2))
@mssalvatore mssalvatore added the Documentation Issues relating to the project's documentation like readme files, guides, etc. label Jun 20, 2024
@shreyamalviya shreyamalviya self-assigned this Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants