# 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](https://github.com/cve-search/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:
- [Corresponding MISP taxonomy](https://github.com/MISP/misp-taxonomies/blob/fd2fbaf2a450e42a490551e5a8e2fa6df039a6b8/vulnerability/machinetag.json#L26-L63)
- [Vulnerability-Lookup documentation](https://vulnerability-lookup.readthedocs.io/en/latest/sightings.html#sightings)
## Installation
[pipx](https://github.com/pypa/pipx) is an easy way to install and run Python applications in isolated environments.
It's easy to [install](https://github.com/pypa/pipx?tab=readme-ov-file#on-linux).
```bash
$ 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.
## Usage
```bash
$ 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](https://github.com/CIRCL/NucleiVuln) is licensed under
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.html)
~~~
Copyright (c) 2024 Computer Incident Response Center Luxembourg (CIRCL)
Copyright (C) 2024 Cédric Bonhomme - https://github.com/cedricbonhomme
~~~
Raw data
{
"_id": null,
"home_page": "https://github.com/cedricbonhomme/NucleiVuln",
"name": "NucleiVuln",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "Vulnerability-Lookup, Vulnerability, CVE, Nuclei, PyVulnerabilityLookup",
"author": "C\u00e9dric Bonhomme",
"author_email": "cedric@cedricbonhomme.org",
"download_url": "https://files.pythonhosted.org/packages/76/77/a6d14afb1afa40022f606dff4189985b4eeda998d66d5f1580bb5f0d97c0/nucleivuln-0.2.1.tar.gz",
"platform": null,
"description": "# NucleiVuln\n\nA client designed to retrieve vulnerability-related information from the Nuclei Git repository of templates.\nThe retrieved data is then transmitted to the\n[Vulnerability-Lookup](https://github.com/cve-search/vulnerability-lookup) API as sightings.\n\nTemplates form the core of the Nuclei scanner. When a template is linked to a vulnerability, the resulting detection\n(observation) is classified as _confirmed_, signifying a higher level of certainty compared to the _seen_ classification.\nMore information about the sightings:\n\n- [Corresponding MISP taxonomy](https://github.com/MISP/misp-taxonomies/blob/fd2fbaf2a450e42a490551e5a8e2fa6df039a6b8/vulnerability/machinetag.json#L26-L63)\n- [Vulnerability-Lookup documentation](https://vulnerability-lookup.readthedocs.io/en/latest/sightings.html#sightings)\n\n\n## Installation\n\n[pipx](https://github.com/pypa/pipx) is an easy way to install and run Python applications in isolated environments.\nIt's easy to [install](https://github.com/pypa/pipx?tab=readme-ov-file#on-linux).\n\n```bash\n$ pipx install NucleiVuln\n$ export NUCLEIVULN_CONFIG=~/.NucleiVuln/conf.py\n$ git clone https://github.com/projectdiscovery/nuclei-templates.git templates\n```\n\nThe configuration for NucleiVuln should be defined in a Python file (e.g., ``~/.NucleiVuln/conf.py``).\nYou must then set an environment variable (``NUCLEIVULN_CONFIG``) with the full path to this file.\n\n## Usage\n\n```bash\n$ NucleiVuln --help\nusage: NucleiVuln [-h] [--init]\n\nFind new Nuclei templates related to a vulnerability in a Git repository.\n\noptions:\n -h, --help show this help message and exit\n --init Find Nuclei templates even if no new commits were detected.\n```\n\n\n## License\n\n[NucleiVuln](https://github.com/CIRCL/NucleiVuln) is licensed under\n[GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.html)\n\n~~~\nCopyright (c) 2024 Computer Incident Response Center Luxembourg (CIRCL)\nCopyright (C) 2024 C\u00e9dric Bonhomme - https://github.com/cedricbonhomme\n~~~\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": null,
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/cedricbonhomme/NucleiVuln",
"Repository": "https://github.com/cedricbonhomme/NucleiVuln"
},
"split_keywords": [
"vulnerability-lookup",
" vulnerability",
" cve",
" nuclei",
" pyvulnerabilitylookup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d239eeac3bc37492cfb47222431240c504ad0a13a77f28a74f4eab4d58f65ad",
"md5": "31386469ed84154e3825155c76b1361e",
"sha256": "eccfd0f356a61cd64e5db594bda779c8f0e38ec47b7877ab0c4c9903eadcb040"
},
"downloads": -1,
"filename": "nucleivuln-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31386469ed84154e3825155c76b1361e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 31090,
"upload_time": "2024-11-20T13:42:24",
"upload_time_iso_8601": "2024-11-20T13:42:24.827193Z",
"url": "https://files.pythonhosted.org/packages/9d/23/9eeac3bc37492cfb47222431240c504ad0a13a77f28a74f4eab4d58f65ad/nucleivuln-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7677a6d14afb1afa40022f606dff4189985b4eeda998d66d5f1580bb5f0d97c0",
"md5": "8c9331903dba9b846e45b0f9dee86059",
"sha256": "fefc65b8e4dfefe792e833d536d7cc6515fe6da3e8c7f5140c95e4bd456ce9ab"
},
"downloads": -1,
"filename": "nucleivuln-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "8c9331903dba9b846e45b0f9dee86059",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 16716,
"upload_time": "2024-11-20T13:42:26",
"upload_time_iso_8601": "2024-11-20T13:42:26.157504Z",
"url": "https://files.pythonhosted.org/packages/76/77/a6d14afb1afa40022f606dff4189985b4eeda998d66d5f1580bb5f0d97c0/nucleivuln-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 13:42:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cedricbonhomme",
"github_project": "NucleiVuln",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nucleivuln"
}
JSON
