guardicore / monkey

Infection Monkey - An open-source adversary emulation platform
https://www.guardicore.com/infectionmonkey/
GNU General Public License v3.0
6.68k stars 786 forks source link

Add exploiters reference #4211

Closed mssalvatore closed 3 months ago

mssalvatore commented 4 months ago

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

Resources

jsonschema2md Diátaxis

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

print(json.dumps(<PLUGIN>Options.model_json_schema(), indent=2))