yawast-ng Plugin System

yawast-ng supports a flexible plugin system that allows users to extend its scanning capabilities by writing and installing their own plugins. This enables custom checks, integrations, and automation tailored to your needs.

How Plugins Work

Plugins are Python packages that implement a specific interface and are discovered automatically by yawast-ng at runtime. Plugins must:

When yawast-ng starts, it loads all installed plugins and makes them available for use during scans.

Creating a Plugin

To create your own plugin:

  1. Copy the Sample Plugin

Use the sample-plugin directory as a starting point. It contains a minimal, working example.

  1. Inherit from a Plugin Base Class

Your plugin should inherit from ScannerPluginBase (or another appropriate base class) and implement the required methods, such as check(self, url: str).

Example:

from yawast.scanner.plugins.scanner_plugin_base import ScannerPluginBase

class MyPlugin(ScannerPluginBase):
    def __init__(self):
        super().__init__()
        self.name = "MyPlugin"
        self.description = "A custom plugin."
        self.version = "0.1.0"

    def check(self, url: str) -> None:
        # Your scanning logic here
        pass
  1. Add an Entry Point

In your setup.py, add an entry point under yawast.plugins:

entry_points={
    "yawast.plugins": [
        "my_plugin = my_plugin:MyPlugin",
    ],
},
  1. Package and Install

Build and install your plugin package:

pip install .

yawast-ng will automatically discover and load your plugin the next time it runs.

Example: Sample Plugin

See the sample-plugin directory for a complete, minimal example. This can be copied and modified to create your own plugins.

Tips

Troubleshooting