Artemis is a modular vulnerability scanner. It's the tool that powers CERT PL scanning activities by
[checking various aspects of website security](https://artemis-scanner.readthedocs.io/en/latest/features.html)
and [building easy-to-read messages ready to be sent to the scanned organizations](https://artemis-scanner.readthedocs.io/en/latest/generating-reports.html).
## [Quick Start π¨](https://artemis-scanner.readthedocs.io/en/latest/quick-start.html) | [Docs π](https://artemis-scanner.readthedocs.io/en/latest/)
If you want to use additional modules that weren't included here due to non-BSD-compatible licenses, browse to the [Artemis-modules-extra](https://github.com/CERT-Polska/Artemis-modules-extra) repository.
If you want to modify/develop Artemis, read **[Development](#development)** first.
**Artemis is experimental software, under active development - use at your own risk.**
To chat about Artemis, [join the Discord server](https://discord.gg/GfUW4mZmy9)!
## Cooperation and conferences
Artemis was presented at BlackHat USA 2024 in Las Vegas and BlackHat Europe 2025 in London. For more information about Artemis at BlackHat [click here](https://www.blackhat.com/us-24/arsenal/schedule/index.html#artemis-modular-vulnerability-scanner-with-automatic-report-generation-39372) and [here](https://blackhat.com/eu-25/briefings/schedule/index.html#nation-scale-secops-how-cert-pl-scans-poland-48918).
The project was also presented at the [71st TF-CSIRT Meeting in Copenhagen](https://tf-csirt.org/tf-csirt/meetings/71st/), [69th TF-CSIRT Meeting in Bucharest](https://tf-csirt.org/tf-csirt/meetings/69th/) and the [CONFidence](https://confidence-conference.org/) conference, among others.
### Cooperation
Artemis development was supported by Google Summer of Code 2024 and 2025.
## Features
For an up-to-date list of features, please refer to [the documentation](https://artemis-scanner.readthedocs.io/en/latest/features.html).
The most important one is the possibility to [easily export](https://artemis-scanner.readthedocs.io/en/latest/generating-reports.html) reports such as:
> The following addresses contain version control system data:
>
> - https://subdomain1.example.com:443/.git/
>
> Making a code repository public may allow an attacker to learn the inner workings of a system, and if it contains passwords or API keys - also gain unauthorized access. Such data shouldn't be publicly available.
>
> The following addresses contain old Joomla versions:
>
> - https://subdomain2.example.com:443 - Joomla 2.5.4
>
> If a site is no longer used, we recommend shutting it down to eliminate the risk of exploitation of known vulnerabilities in older Joomla versions. Otherwise, we recommend regular Joomla core and plugin updates.
The possibility to automatically prepare such reports enabled us to notify entities in our constituency about [hundreds of thousands](https://cert.pl/en/posts/2024/01/artemis-security-scanner/) of vulnerabilities.
## Screenshots
## Development
To start a locally modified version of Artemis, run:
```commandline
./scripts/start --mode=development
```
This script automatically copies the example environment file (`env.example`) to `.env` if it doesn't exist. You can then configure the settings in the .env file according to your needs. This includes customizing the user-agent by setting the CUSTOM_USER_AGENT variable, as well as other relevant parameters. For a complete list of configuration variables and their descriptions, please refer to the [Configuration section in the documentation](https://artemis-scanner.readthedocs.io/en/latest/user-guide/configuration.html).
The Artemis image is then built locally (from the code you are developing) not downloaded from Docker Hub.
For `web`, you will also be able to see the results of code modifications on the page without reloading the entire container.
### Tests
To run the tests, use:
```console
./scripts/test
```
> [!WARNING]
> Avoid using `python -m unittest` directly as the `command:` in `docker-compose.test.yaml`.
When Python runs as PID 1, subprocesses, especially Go binaries like Nuclei, suffer from slow or degraded I/O because PID 1 handles signals and stdout/stderr differently.
Use unittest-parallel instead, since its worker processes avoid the PID 1 issue.
### Code formatting
Artemis uses `pre-commit` to run linters and format the code.
`pre-commit` is executed on CI to verify that the code is formatted properly.
To run it locally, use:
```console
pre-commit run --all-files
```
To set up `pre-commit` so that it runs before each commit, use:
```console
pre-commit install
```
### Modifying dependencies
We use `pip-tools` to manage dependencies. To add or update a dependency:
1. Modify `requirements.in` (or `docs/requirements.in` for documentation dependencies),
2. Run `./scripts/compile-requirements` to generate the frozen `requirements.txt` file(s),
3. Commit both the `.in` and `.txt` files.
### Building the docs
To build the documentation, use:
```console
cd docs
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
make html
```
## How do I write my own module?
Please refer to [the documentation](https://artemis-scanner.readthedocs.io/en/latest/user-guide/writing-a-module.html).
## Contributing
Contributions are welcome! We will appreciate both ideas for new Artemis modules (added as [GitHub issues](https://github.com/CERT-Polska/Artemis/issues)) as well as pull requests with new modules or code improvements.
However obvious it may seem, we kindly remind you that by contributing to Artemis, you agree that the BSD 3-Clause License shall apply to your input automatically, without the need for any additional declarations to be made.
### Development
Before opening PR please make sure to install `pre-commit`:
- `pre-commit install`
And run it against your changes.
## Contributors
Huge thanks to the following people that contributed to Artemis development, especially the [KN Cyber](https://kncyber.pl/) science club of [Warsaw University of Technology](https://pw.edu.pl) that initiated the project!
