Plugin Guide 🔌

Managing Plugins

Plugin Suggestion

If you want a suggest an idea for a new plugin please do it here.

Adding a New Plugin

To add a new plugin you need to use the --add <URL> option. The URL needs to be a remote github repository hosting a plugins.json file.

drew@DESKTOP-A5AO3TO:~$ ds --add https://github.com/DataSurgeon-ds/ds-winreg-plugin/
[*] Download and added plugin: https://github.com/DataSurgeon-ds/ds-winreg-plugin/

Listing All Plugins

To list all plugins you can use the --list option.

drew@DESKTOP-A5AO3TO$ ds --list
Plugin File: /home/drew/.DataSurgeon/plugins.json

Source URL                                         | Version | Argument Long Name
https://github.com/DataSurgeon-ds/ds-winreg-plugin | 1.0.0   | winregistry
https://github.com/DataSurgeon-ds/ds-cve-plugin    | 1.0.0   | cve

How to Use Your New Plugin

Once your plugin file is loaded, the option will be added as an additional argument. As you can see the name of the argument is the Argument Long Name.

drew@DESKTOP-A5AO3TO$ ds -h

Options:
   ......
  -a, --aws                    Extract AWS keys
      --winregistry            Extracts windows registry paths
  -V, --version                Print version

Updating a Plugin

You can update an existing plugin by using it's Source URL or you can update all plugins by passing all.

Updating a Specific Plugin

drew@DESKTOP-A5AO3TO$ ds --update https://github.com/DataSurgeon-ds/ds-cve-plugin
[*] Updated Plugin: https://github.com/DataSurgeon-ds/ds-cve-plugin

Updating all Plugins

drew@DESKTOP-A5AO3TO$ ds --update all
[*] Updated Plugin: https://github.com/DataSurgeon-ds/ds-winreg-plugin
[*] Updated Plugin: https://github.com/DataSurgeon-ds/ds-cve-plugin

Removing a Plugin

To remove a plugin you don't want anymore you can use the --remove option.

drew@DESKTOP-A5AO3TO:~$ ds --remove https://github.com/DataSurgeon-ds/ds-winreg-plugin/
[*] Removed plugin: https://github.com/DataSurgeon-ds/ds-winreg-plugin/