Metadata-Version: 2.4
Name: MetasploitSight
Version: 0.1.0
Summary: A client designed to retrieve vulnerability-related information from the modules available in Metasploit.
License-Expression: GPL-3.0-or-later
License-File: COPYING
Keywords: Vulnerability-Lookup,Vulnerability,CVE,Metasploit
Author: Cédric Bonhomme
Author-email: cedric.bonhomme@circl.lu
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Security
Requires-Dist: pyvulnerabilitylookup (>=2.14.0)
Requires-Dist: requests (>=2.32.5)
Requires-Dist: valkey (>=6.1.0,<7.0.0)
Project-URL: Changelog, https://github.com/vulnerability-lookup/MetasploitSight/blob/main/CHANGELOG.md
Project-URL: Homepage, https://github.com/vulnerability-lookup/MetasploitSight
Project-URL: Repository, https://github.com/vulnerability-lookup/MetasploitSight
Description-Content-Type: text/markdown

# MetasploitSight

A client designed to retrieve vulnerability-related information from the modules available in Metasploit.
It monitors changes to the file [db/modules_metadata_base.json](https://github.com/rapid7/metasploit-framework/tree/master/db).

The collected data is then transmitted to the
[Vulnerability-Lookup](https://github.com/vulnerability-lookup/vulnerability-lookup) API  as sightings.


## Installation

[pipx](https://github.com/pypa/pipx) is an easy way to install and run Python applications in isolated environments.

```bash
$ pipx install MetasploitSight
$ export METASPLOITSIGHT_CONFIG=~/.MetasploitSight/conf.py
$ git clone https://github.com/rapid7/metasploit-framework/ metasploit-repository
```

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


## Usage

Run the client:

```
$ MetasploitSight
```

Starts the MetasploitSight client. It fetches updates from the official Metasploit repository and
checks db/modules_metadata_base.json for changes.


Show available commands and options:

```
$ MetasploitSight --help
```


## License

[MetasploitSight](https://github.com/vulnerability-lookup/MetasploitSight) is licensed under
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.html)

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

