Artemis

<h1> <picture> <source media="(prefers-color-scheme: dark)" srcset="static/images/logo_dark.png"> <img alt="logo" width="400px" src="static/images/logo.png"> </picture> </h1>

Artemis is a modular vulnerability scanner. It's the tool that powers CERT PL scanning activities by checking various aspects of website security and building easy-to-read messages ready to be sent to the scanned organizations.

Quick Start 🔨 | Docs 📚

If you want to use additional modules that weren't included here due to non-BSD-compatible licenses, browse to the Artemis-modules-extra repository.

If you want to modify/develop Artemis, read Development first.

Artemis is experimental software, under active development - use at your own risk.

To chat about Artemis, join the Discord server!

Cooperation and conferences

<div style="margin-bottom: 5px"> <img alt="BlackHat" src="static/images/blackhat.png"> </div>

Artemis was presented at BlackHat USA 2024 in Las Vegas. For more information about Artemis at BlackHat USA click here.

<br/> <div style="margin-bottom: 5px"> <img alt="BlackHat" src="static/images/tf_csirt.png"> </div>

The project was also presented at the 71st TF-CSIRT Meeting in Copenhagen, 69th TF-CSIRT Meeting in Bucharest and the CONFidence conference, among others.

Cooperation

Artemis development was supported by Google Summer of Code 2024.

Features

For an up-to-date list of features, please refer to the documentation. The most important one is the possibility to easily export 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 of vulnerabilities.

Screenshots

<a name="development"></a>

Development

To start a locally modified version of Artemis, run:

 ./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.

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:

./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:

pre-commit run --all-files

To set up pre-commit so that it runs before each commit, use:

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 pre-commit run pip-compile --all-files to generate the frozen requirements.txt file(s),
3. Commit both the .in and .txt files.

Building the docs

To build the documentation, use:

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.

Contributing

Contributions are welcome! We will appreciate both ideas for new Artemis modules (added as GitHub 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 science club of Warsaw University of Technology that initiated the project!

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kazet"><img src="https://avatars.githubusercontent.com/u/1233067?v=4?s=100" width="100px;" alt="kazet"/><br />_<b>kazet</b></a><br /><a href="https://github.com/CERT-Polska/Artemis/commits?author=kazet" title="Code">💻</a> <a href="https://github.com/CERT-Polska/Artemis/commits?author=kazet" title="Documentation">📖</a> <a href="#ideas-kazet" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-kazet" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/CERT-Polska/Artemis/pulls?q=is%3Apr+reviewed-by%3Akazet" title="Reviewed Pull Requests">👀</a> <a href="#talk-kazet" title="Talks">📢</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/BonusPlay"><img src="https://avatars.githubusercontent.com/u/8405359?v=4?s=100" width="100px;" alt="Adam Kliś"/><br />_{<b>Adam Kliś</b>}</a><br /><a href="#question-BonusPlay" title="Answering Questions">💬</a> <a href="https://github.com/CERT-Polska/Artemis/commits?author=BonusPlay" title="Code">💻</a> <a href="#ideas-BonusPlay" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/CERT-Polska/Artemis/pulls?q=is%3Apr+reviewed-by%3ABonusPlay" title="Reviewed Pull Requests">👀</a> <a href="#talk-BonusPlay" title="Talks">📢</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/anna1492"><img src="https://avatars.githubusercontent.com/u/142449177?v=4?s=100" width="100px;" alt="anna1492"/><br />_{<b>anna1492</b>}</a><br /><a href="https://github.com/CERT-Polska/Artemis/issues?q=author%3Aanna1492" title="Bug reports">🐛</a> <a href="https://github.com/CERT-Polska/Artemis/commits?author=anna1492" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ELOOLE"><img src="https://avatars.githubusercontent.com/u/75997374?v=4?s=100" width="100px;" alt="Michał M."/><br />_{<b>Michał M.</b>}</a><br /><a href="https://github.com/CERT-Polska/Artemis/commits?author=ELOOLE" title="Code">💻</a> <a href="#ideas-ELOOLE" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/cyberamt"><img src="https://avatars.githubusercontent.com/u/154326307?v=4?s=100" width="100px;" alt="cyberamt"/><br />_{<b>cyberamt</b>}</a><br /><a href="https://github.com/CERT-Polska/Artemis/commits?author=cyberamt" title="Code">💻</a> <a href="#ideas-cyberamt" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/martclau"><img src="https://avatars.githubusercontent.com/u/7753513?v=4?s=100" width="100px;" alt="martclau"/><br />_{<b>martclau</b>}</a><br /><a href="https://github.com/CERT-Polska/Artemis/commits?author=martclau" title="Code">💻</a> <a href="#ideas-martclau" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/szymsid"><img src="https://avatars.githubusercontent.com/u/26324394?v=4?s=100" width="100px;" alt="szymsid"/><br />_{<b>szymsid</b>}</a><br /><a href="https://github.com/CERT-Polska/Artemis/commits?author=szymsid" title="Code">💻</a> <a href="http