IMPORTANT: The templated language is not yet approved for wide usage. We are currently running it as part of a beta with a selected fews. This warning will be removed once the language can be used as the default.

Getting started with templated plugins

In this documentation, you will learn how to write a plugin for Tsunami in the templated format.

What will be covered

• Introduction

  • What is a templated plugin?
  • How does it work?
  • How do I know how to write a templated plugin?
  • Execution workflow of a templated plugin

• Bootstrapping the plugin

  • Understanding the vulnerability
  • Providing information about our plugin and the vulnerability
  • Configuring the plugin

• Writing the first actions

• Putting it together in workflows

• Using variables

  • Using variables
  • Extracting information to local variables
  • Predefined variables

• Using the callback server

• Using cleanup actions

• Writing unit tests

• Glossaries

  • Predefined variables
  • Magic tests URIs when mocking HTTP

• Appendixes

  • Convention: How to name a plugin
  • Convention: How to name an action
  • Convention: Naming tests

Let’s get started!

Introduction