Skip to content
Plugin boilerplate for decker, declarative penetration testing orchestration framework.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build/package
cmd/decker-plugin
examples
Dockerfile
Makefile
README.md
decker-plugin.hcl

README.md

Quick start

  1. make docker_run
  2. make build_plugin
  3. make run
  4. cat /tmp/reports/decker-plugin.report.txt

Directory structure

.
├── build
│   └── package
│       └── Dockerfile
├── cmd
│   └── decker-plugin
│       └── main.go
├── decker-plugin.hcl
├── examples
│   └── plugin-schema-test.hcl
├── Makefile
└── README.md
  • cmd/decker-plugin/main.go contains the "Hello World" plugin code. This is a working plugin that can be compiled and run immediately to get a feel for what's happening. If you make changes to expected inputs in decker-plugin.hcl, be sure to make changes in examples/plugin-test.hcl as well to set values to the inputs. These will be available in main.go in the inputsMap as myNewVariable := (*inputsMap)["my_decker_variable_name"]. Anything assigned to (*resultsMap)["raw_output"] will be written to a report file at /tmp/reports/decker-plugin.report.txt.
  • decker-plugin.hcl declares the inputs that your plugin expects to have configured by the user.
  • examples/plugin-test.hcl is a simple decker config file that will run your new plugin.
You can’t perform that action at this time.