Custom Templates

The Custom Templatesarrow-up-right page lets you create your own Nuclei vulnerability scanning templates. This is useful when you want to test for specific vulnerabilities unique to your environment, or when you want to extend Ryft's scanning capabilities beyond the built-in modules.

Accessing Custom Templates

Click on your avatar on the top right hand corner -> Settings -> Custom Templatesarrow-up-right

What Are Nuclei Templates?

Nuclei is an open-source vulnerability scanner that uses YAML-based templates to define what to test for. Each template describes:

  • What HTTP request to send

  • What to look for in the response (matchers)

  • The severity of the finding if it matches

Ryft comes with thousands of built-in templates. Custom Templates let you add your own.

Creating a Template

1

Add a new template

Click Add Template in the top-right corner.

2

Template details

Fill in the template details:

  • Template Name — A descriptive name for your template

  • Description — What the template tests for

  • Severity — The severity level if the template matches (Info, Low, Medium, High, Critical)

  • Template Content — The YAML template definition

3

Save the template

Click Create to save the template.

Example Template

Managing Templates

The templates table shows all your custom templates with:

  • Name — Template name

  • Description — What it tests for

  • Severity — The assigned severity level

  • Tags — Optional tags for organization

  • Created — When the template was created

Actions

  • View (eye icon) — Opens a read-only view of the template content

  • Edit (pencil icon) — Opens the edit dialog to modify the template

  • Validate — Checks the template syntax for errors before using it in scans

  • Delete (trash icon) — Permanently removes the template

Using Custom Templates in Scans

1

Select Custom Templates module

When launching a scan from the Domainsarrow-up-right page, select the Custom Templates module in the scan configuration dialog.

2

Choose templates to include

In the scan configuration, you'll see a list of your templates — select which ones to include.

3

Run with scans and schedules

The selected templates will run as part of the vulnerability scan.

Custom templates also work with Scheduled Scans — select them during schedule configuration and they'll run on every scheduled execution.

Results from custom templates appear on the Vulnerability Dashboard under the "Custom Templates" module and on the Findingsarrow-up-right page.

Last updated