inspiregroup/artemis-backend repository overview

⁠ARTEMIS

Table of Contents

• General⁠
• Features⁠
• Architecture⁠
• Getting Started⁠
• Minimum Technical Requirements⁠
• How to Install⁠
• How to Configure and Run⁠
• Demo⁠
• Contributing⁠
• Development Team and Contact⁠
• Versioning⁠
• Authors and Contributors⁠
• License⁠
• Acknowledgements and Funding Sources⁠
• Powered By⁠

⁠General

ARTEMIS is a defense approach against BGP prefix hijacking attacks. It is (a) based on accurate and fast detection operated by the AS itself, by leveraging the pervasiveness of publicly available BGP monitoring services and it (b) enables flexible and fast mitigation of hijacking events. Compared to existing approaches/tools, ARTEMIS combines characteristics desirable to network operators such as comprehensiveness, accuracy, speed, privacy, and flexibility. With the ARTEMIS approach, prefix hijacking can be neutralized within a minute!

NOTE: Depending on the preferences of the user, ARTEMIS can be used in 3 basic modes depending on the combination of enabled micro-services in the user interface:

1. Passive monitor (monitoring enabled)
2. Passive detector (monitoring + detection enabled)
3. Active joint detector and user-triggered mitigator (monitoring + detection + mitigation enabled)

Any of this combinations is valid. To start with, we recommend using mode (2).

You can read more about the ARTEMIS methodology and research experiments on the ARTEMIS webpage⁠.

This repository contains the software of ARTEMIS as a tool. ARTEMIS can be run on a server/VM as a modular and extensible multi-container application. It has been tested at a major greek ISP, a dual-homed edge academic network, and a major US R&E backbone network.

⁠Features

For a detailed list of supported features please check the CHANGELOG⁠ file (section: "Added"). The following main features are supported:

• Real-time monitoring of the changes in the BGP routes of the prefixes originated by the AS running ARTEMIS.
• Real-time detection and notifications of BGP prefix hijacking attacks/events of the following types (please refer to the attack taxonomy in our ARTEMIS ToN paper⁠):
  • exact-prefix type-0/1
  • sub-prefix of any type
  • squatting attacks.
• Automatic/custom tagging of detected BGP hijack events (ongoing, resolved, ignored, under mitigation, withdrawn and outdated).
• Manual or manually controlled mitigation of BGP prefix hijacking attacks.
• Comprehensive web-based User Interface (UI).
• Configuration file editable by the operator (directly or via the UI), containing information about: prefixes, ASNs, monitors and ARTEMIS rules ("ASX originates prefix P and advertises it to ASY").
• Support for both IPv4 and IPv6 prefixes.
• Support for both mobile and desktop environments (UI).
• Modularity/extensibility by design.

⁠System Architecture

⁠Getting Started

ARTEMIS is built as a multi-container Docker application. The following instructions will get you a containerized copy of the ARTEMIS tool up and running on your local machine. For instructions on how to set up ARTEMIS in a Kubernetes environment, please contact the ARTEMIS team⁠.

⁠Minimum Technical Requirements

• CPU: 4 cores
• RAM: 4 GB
• HDD: 100 GB (less may suffice, depending on the use case)
• NETWORK: 1 public-facing network interface
• OS: Ubuntu Linux 16.04+
• SW PACKAGES: docker-ce and docker-compose should be pre-installed (see instructions later) and docker should have sudo privileges, if only non-sudo user is allowed
• Other: SSH server

Moreover, one may optionally configure firewall rules related to the server/VM. We recommend using ufw⁠ for this task. Please check the comments in the respective script we provide and set the corresponding <> fields in the file before running:

sudo ./other/ufw_setup.sh

NOTE: For security reasons, we highly recommend protecting your machine with such rules.

⁠How to Install

1. Make sure that your Ubuntu package sources are up-to-date:

   sudo apt-get update
   

   Copy

2. If not already installed, follow the instructions here⁠ to install the latest version of the docker tool for managing containers, and here⁠ to install the docker-compose tool for supporting multi-container Docker applications.

   In production, we have used the following versions successfully:

   $ docker -v
   Docker version 18.09.0, build 4d60db4
   $ docker-compose -v
   docker-compose version 1.20.0, build ca8d3c6
   

   Copy

3. If you would like to run docker without using sudo, please create a docker group, if not existing:

   sudo groupadd docker
   

   Copy

   and then add the user to the docker group:

   sudo usermod -aG docker $USER
   

   Copy

   For more instructions and potential debugging on this please consult this webpage⁠.

4. Install ntp for time synchronization:

   sudo apt-get install ntp
   

   Copy

5. Install git for downloading ARTEMIS:

   sudo apt-get install git
   

   Copy

   and then download ARTEMIS from github (if not already downloaded).

6. The docker-compose utility is configured to pull the latest stable released images that are built remotely on docker cloud⁠. No further installation/building actions are required on your side at this point.

⁠How to Configure and Run

Please check our wiki⁠.

The basic actions that you will need to do, stated here for brevity, are the following:

1. Edit environment variables in .env file (especially the security-related variables)

2. Configure certificates and NGINX reverse proxy for https termination

   frontend/webapp/configs/certs
   frontend/webapp/configs/nginx.conf
   

   Copy

3. Start ARTEMIS

   docker-compose up -d
   

   Copy

4. Visit UI and configure ARTEMIS

   https://<ARTEMIS_HOST>
   

   Copy

5. Activate backups (recommended)

   docker-compose exec postgres bash
   crond
   exit
   

   Copy

6. Stop ARTEMIS (optional)

   docker-compose stop
   

   Copy

Note: We highly recommend going through the detailed wiki instructions before using ARTEMIS for the first time.

⁠Demo

A running demo of ARTEMIS based on the configuration of our home institute (FORTH) can be found here⁠. You can access the demo as a guest (non-admin) user by using the following credentials:

• username: "guest"
• password: "guest@artemis2018"

Please do not request new accounts on the demo portal. Use the given credentials to browse ARTEMIS as a guest user.

⁠Contributing

Please check this file⁠.

⁠Development Team and Contact

We follow a custom Agile approach for our development.

If you need to contact us about a bug, an issue or a question you have; you can reach us over at our Discord Community Server⁠. Otherwise, you can contact the ARTEMIS developers via e-mail as follows:

• Dimitrios Mavrommatis (backend): mavromat_at_ics_dot_forth_dot_gr
• Petros Gigis (frontend): gkigkis_at_ics_dot_forth_dot_gr
• Vasileios Kotronis (coordinator): vkotronis_at_ics_dot_forth_dot_gr

⁠Versioning

Please check this file⁠.

⁠Authors and Contributors

Please check this file⁠.

⁠License

The ARTEMIS software is open-sourced under the BSD-3 license. Please check the license file⁠.

Note that all external dependencies are used in a way compatible with BSD-3 (that is, we conform to the compatibility rules of each and every dependency); the associated software packages and their respective licenses are documented in detail in this file⁠, where we provide links to their homepages and licenses.

⁠Acknowledgements and Funding Sources

This work is supported by the following funding sources on the European side (FORTH):

• European Research Council (ERC) grant agreement no. 338402 (NetVolution Project⁠)
• RIPE NCC Community Projects Fund⁠

The following funding sources supported the collaboration with CAIDA UCSD, on the US side:

• National Science Foundation (NSF) grants OAC-1848641 and CNS-1423659
• Department of Homeland Security (DHS) Science and Technology Directorate, Cyber Security Division (DHS S&T/CSD) via contract number HHSP233201600012C
• Comcast Innovation Fund

⁠Powered By

DISCLAIMER: We do not own these logo images. All links to the respective project pages from where the logos were downloaded are contained in this file⁠, together with their respective licenses. The sole purpose of this section is to thank the open-source software projects that enabled ARTEMIS with their functionality and APIs, by making them as visible as possible. The list of project logos is not exhaustive. Image copyright is retained by the respective project's copyright owners.