Skip to content

A client designed to retrieve vulnerability-related information from the Nuclei Git repository of templates. The gathered data is subsequently transmitted to the Vulnerability-Lookup API.

License

Notifications You must be signed in to change notification settings

vulnerability-lookup/NucleiVuln

Repository files navigation

NucleiVuln

A client designed to retrieve vulnerability-related information from the Nuclei Git repository of templates. The retrieved data is then transmitted to the Vulnerability-Lookup API as sightings.

Templates form the core of the Nuclei scanner. When a template is linked to a vulnerability, the resulting detection (observation) is classified as confirmed, signifying a higher level of certainty compared to the seen classification. More information about the sightings:

Installation

pipx is an easy way to install and run Python applications in isolated environments. It's easy to install.

$ pipx install NucleiVuln
$ export NUCLEIVULN_CONFIG=~/.NucleiVuln/conf.py
$ git clone https://github.com/projectdiscovery/nuclei-templates.git templates

The configuration for NucleiVuln should be defined in a Python file (e.g., ~/.NucleiVuln/conf.py). You must then set an environment variable (NUCLEIVULN_CONFIG) with the full path to this file.

With Docker

git clone https://github.com/vulnerability-lookup/NucleiVuln
cd NucleiVuln

# Make sure conf.py exists in the project root before running
docker compose up --build

Note

The docker-compose.yml expects a conf.py file in the root directory. You can create it manually or copy the provided example:

$ cp nucleivuln/conf_sample.py conf.py

Usage

$ NucleiVuln --help
usage: NucleiVuln [-h] [--init]

Find new Nuclei templates related to a vulnerability in a Git repository.

options:
  -h, --help  show this help message and exit
  --init      Find Nuclei templates even if no new commits were detected.

License

NucleiVuln is licensed under GNU General Public License version 3

Copyright (c) 2024-2025 Computer Incident Response Center Luxembourg (CIRCL)
Copyright (C) 2024-2025 Cédric Bonhomme - https://github.com/cedricbonhomme

About

A client designed to retrieve vulnerability-related information from the Nuclei Git repository of templates. The gathered data is subsequently transmitted to the Vulnerability-Lookup API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •