Esta Nuclei Action facilita a orquestração do Nuclei com o GitHub Action. Integre todos os seus Nuclei Templates em poderosos fluxos de trabalho de segurança contínua e faça disso parte do seu ciclo de vida de desenvolvimento de software seguro.

Nuclei Action

Compatibilidade

• v3.0.0+ é executado no Node.js v24 e adota uma interface de linha de comando em primeiro lugar, aceitando inputs como version, install-only, args, etc., e outputs apenas para stdout e stderr.
• v2.0.0+ e v2.x dependem de inputs específicos da ação, como target, urls, templates, workflows, flags, e vários toggles de exportador/relatórios; v2.x estão obsoletos e sem suporte após 1º de março de 2026. Consulte MIGRATION.md antes de atualizar.
• v1+ é executado no Node.js v16 e usa inputs como target, urls, templates, workflows, output, json, include-rr, config, report-config, github-report, github-token, sarif-export, markdown-export e flags.

Inputs

[!IMPORTANT]

• config e config-path não devem ser definidos juntos.
• args sempre têm precedência sobre config ou config-path.

[!NOTE] Quando o log de depuração está habilitado, esta ação adiciona automaticamente os flags -debug e -verbose ao Nuclei.

Outputs

Execução

Esta ação é uma ação node24.

Uso

- 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 }}

Exemplo

Configuração padrão (Nuclei mais recente)

- uses: projectdiscovery/nuclei-action@v3
  with:
    args: -u http://scanme.sh

Configuração com versão específica

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: v3.6.0
    args: -u http://scanme.sh

Configurar ou instalar o Nuclei sem executar varreduras

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: v3.6.0
    install-only: true

- run: nuclei -version

ou instalar apenas e sem cache:

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: v3.6.0
    install-only: true
    cache: false

- run: nuclei -version

Configuração com o arquivo de configuração do Nuclei

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: latest
    config: |
      target:
        - http://scanme.sh
      sarif-export: results.sarif

ou passe-a via variáveis:

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: latest
    config: ${{ vars.NUCLEI_CONFIG }}

ou via arquivo de configuração gerenciado pelo repositório:

- uses: projectdiscovery/nuclei-action@v3
  with:
    version: latest
    config-path: path/to/nuclei.yaml

Configuração com 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

Configuração com relatórios

- 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

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

Contribuindo

Aceitamos contribuições! Consulte o nosso Guia de Contribuição para obter detalhes sobre como começar.

Licença

MIT. Consulte LICENSE para mais detalhes.