
Schwachstellenscan mit Nuclei
Mit dieser Nuclei Action lässt sich Nuclei ganz einfach mit GitHub Action orchestrieren. Integrieren Sie alle Ihre Nuclei Templates in leistungsstarke, kontinuierliche Sicherheits-Workflows und machen Sie sie zu einem festen Bestandteil Ihres sicheren Softwareentwicklungslebenszyklus.
Nuclei Action
v2.0.0+ und v2.x basieren auf aktionsspezifischen Eingaben wie target, urls, templates, workflows, flags sowie verschiedenen Exporter-/Reporting-Schaltern; v2.x ist veraltet und wird nach dem 1. März 2026 nicht mehr unterstützt. Lesen Sie vor dem Upgrade MIGRATION.md.v1+ läuft auf Node.js v16 und verwendet Eingaben wie target, urls, templates, workflows, output, json, include-rr, config, report-config, github-report, github-token, sarif-export, markdown-export und flags.| Name | Beschreibung | Erforderlich | Standard |
|---|---|---|---|
version | Einrichtung mit einer bestimmten Version („latest" oder im Format „vX.Y.Z"). | true | latest |
install-only | Nuclei installieren, ohne Scans auszuführen. | false | false |
args | Argumente, die an Nuclei übergeben werden. | false | "" |
config | Inhalt der Nuclei-Konfigurationsdatei. | false | "" |
config-path | Pfad zur Nuclei-Konfigurationsdatei. | false | "" |
cache | Caching von Nuclei-Zwischenspeichern, Konfigurationen, Templates und Browser aktivieren. | false | true |
token | GitHub-Token. Es wird verwendet, um Nuclei-Releases von GitHub abzurufen. | true | ${{ github.token }} |
[!IMPORTANT]
configundconfig-pathdürfen nicht gleichzeitig gesetzt werden.argshaben immer Vorrang vorconfigoderconfig-path.
[!NOTE] Wenn Debug-Logging aktiviert ist, fügt diese Action Nuclei automatisch die Flags
-debugund-verbosehinzu.
| Name | Beschreibung |
|---|---|
stdout | Die Standardausgabe von Nuclei |
stderr | Die Standardfehlerausgabe von Nuclei |
Diese Action ist eine node24-Action.
- uses: projectdiscovery/nuclei-action@v3
with:
version:
# Setup with specific version ("latest" or in format "vX.Y.Z").
#
# Required: true
# Default: latest
install-only:
# Install Nuclei without running scans.
#
# Required: false
# Default: false
args:
# Arguments to pass to Nuclei.
#
# Required: false
# Default: ""
config:
# Nuclei configuration file content.
#
# Required: false
# Default: ""
config-path:
# Path to Nuclei configuration file.
#
# Required: false
# Default: ""
cache:
# Enable caching of Nuclei caches, configs, templates, and browser.
#
# Required: false
# Default: true
token:
# GitHub Token. It is used to fetch Nuclei releases from GitHub.
#
# Required: true
# Default: ${{ github.token }}
Standard-Einrichtung (aktuelles Nuclei)
- uses: projectdiscovery/nuclei-action@v3
with:
args: -u http://scanme.sh
Einrichtung mit einer bestimmten Version
- uses: projectdiscovery/nuclei-action@v3
with:
version: v3.6.0
args: -u http://scanme.sh
Nuclei einrichten oder installieren, ohne Scans auszuführen
- uses: projectdiscovery/nuclei-action@v3
with:
version: v3.6.0
install-only: true
- run: nuclei -version
oder nur installieren und ohne Cache:
- uses: projectdiscovery/nuclei-action@v3
with:
version: v3.6.0
install-only: true
cache: false
- run: nuclei -version
Einrichtung mit Nuclei-Konfiguration
- uses: projectdiscovery/nuclei-action@v3
with:
version: latest
config: |
target:
- http://scanme.sh
sarif-export: results.sarif
oder übergeben Sie sie über Variablen:
- uses: projectdiscovery/nuclei-action@v3
with:
version: latest
config: ${{ vars.NUCLEI_CONFIG }}
oder über eine im Repository verwaltete Konfigurationsdatei:
- uses: projectdiscovery/nuclei-action@v3
with:
version: latest
config-path: path/to/nuclei.yaml
Einrichtung mit GitHub-Code-Scanning
- uses: projectdiscovery/nuclei-action@v3
with:
version: latest
config: |
target:
- http://scanme.sh
sarif-export: results.sarif
- uses: github/codeql-action/upload-sarif@v3
if: success()
with:
sarif_file: results.sarif
category: nuclei-results
Einrichtung mit Reporting
- uses: projectdiscovery/nuclei-action@v3
with:
args: -u http://scanme.sh
config: |
report-config: issue-tracker-config.yaml
env:
GITHUB_BASE_URL: https://localhost:8443/github
GITHUB_USERNAME: test-username
GITHUB_OWNER: test-owner
GITHUB_TOKEN: ${{ secrets.GITHUB_PAT }}
GITHUB_PROJECT_NAME: test-project
issue-tracker-config.yaml (Datei im Repository):github:
# base-url is the optional self-hosted GitHub application url
base-url: $GITHUB_BASE_URL # read from environment variable
# username is the username of the GitHub user
username: $GITHUB_USERNAME # read from environment variable
# owner is the owner name of the repository for issues
owner: $GITHUB_OWNER # read from environment variable
# token is the token for GitHub account
token: $GITHUB_TOKEN # read from environment variable
# project-name is the name of the repository
project-name: $GITHUB_PROJECT_NAME # read from environment variable
# issue-label is the label of the created issue type
issue-label: bug
# allow-list sets a tracker level filter to only create issues for templates with
# these severity labels or tags (does not affect exporters. set those globally)
allow-list:
severity: high, critical
tags: network
# deny-list sets a tracker level filter to never create issues for templates with
# these severity labels or tags (does not affect exporters. set those globally)
deny-list:
severity: low
# duplicate-issue-check flag to enable duplicate tracking issue check.
duplicate-issue-check: false
Siehe https://github.com/projectdiscovery/nuclei/blob/dev/cmd/nuclei/issue-tracker-config.yaml.
Wir freuen uns über Beiträge! Details zum Einstieg finden Sie in unserem Leitfaden für Mitwirkende.
MIT. Siehe LICENSE für weitere Details.