Skip to main content

A client designed to retrieve vulnerability-related observations from the Nuclei Git repository of templates and pushes them to a Vulnerability-Lookup instance.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nucleivuln-1.0.1.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nucleivuln-1.0.1-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file nucleivuln-1.0.1.tar.gz.

File metadata

  • Download URL: nucleivuln-1.0.1.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nucleivuln-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b9f6ed7a33e93ae32eef9711937e78ce7b2b83d657c96cd42998ec301342d8de
MD5 eb8be34d3004d7624839f319372e79e8
BLAKE2b-256 43aaa431e5e9e0cc1483590f1d61f375c4a9be80bb217a9f9af00ff204586412

See more details on using hashes here.

Provenance

The following attestation bundles were made for nucleivuln-1.0.1.tar.gz:

Publisher: release.yml on vulnerability-lookup/NucleiVuln

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nucleivuln-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: nucleivuln-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nucleivuln-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2b93478d3b059c06605335700346f6278c5608a58d21ec8e4db2fe1a3e7cefb
MD5 7c6d29d64e40423313cf03dcb1c274b1
BLAKE2b-256 16e927e0c5189f79aa3192575bcabbeca618c46538508a724d190604a7c47143

See more details on using hashes here.

Provenance

The following attestation bundles were made for nucleivuln-1.0.1-py3-none-any.whl:

Publisher: release.yml on vulnerability-lookup/NucleiVuln

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page