Please cite the following paper when using this tool.
Ibrahim, Amjad, Stevica Bozhinoski, and Alexander Pretschner. "Attack graph generation for microservice architecture." Proceedings of the 34th ACM/SIGAPP Symposium on Applied Computing. ACM, 2019.
@inproceedings{ibrahim2019attack, title={Attack graph generation for microservice architecture}, author={Ibrahim, Amjad and Bozhinoski, Stevica and Pretschner, Alexander}, booktitle={Proceedings of the 34th ACM/SIGAPP Symposium on Applied Computing}, pages={1235--1242}, year={2019}, organization={ACM} }
Microservices are increasingly dominating the field of service systems, among their many characteristics are technology heterogeneity, communicating small services, and automated deployment. Therefore, with the increase of utilizing third-party components distributed as images, the potential vulnerabilities existing in a microservice-based system increase.
One of the most famous microservice architectures is Docker. This project generates attack graphs for Docker projects.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
This project works currently only on Ubuntu 16.04.4 LTS. Executing the program for the first time will download all of the needed libraries/components including:
- Python 3.6 - a programming language.
- Pip - a tool for installing Python packages.
- Docker Community Edition (CE) - a computer program that performs operating-system-level virtualization, also known as "containerization".
- Docker Compose - a tool for defining and running multi-container Docker applications.
- Go - an open source programming language that makes it easy to build simple, reliable, and efficient software.
- Clairctl - a lightweight command-line tool doing the bridge between Registries as Docker Hub, Docker Registry or Quay.io, and the CoreOS vulnerability tracker, Clair.
- Graphviz - an open source graph visualization software.
- Yaml - a human-readable data serialization language.
- Networkx - a Python package for the creation, manipulation, and study of the structure, dynamics, and functions of complex networks.
- Numpy - a fundamental package for scientific computing with Python.
All of the libraries/components indicated above are automatically installed during the first running of the program. For how to run the program, please refer to the commands bellow.
In order to run the program, the user needs to enter the home directory of the project and the following command on the terminal should be run:
$ sudo ./attack-graph-generator.sh ./examples/atsea
The above command starts the attack-graph-generator.sh script and generates an attack graph for the system ./examples/atsea. This command will download and install the required libraries and set up environment variables when run for the first time. Afterward, it performs the attack graph analysis.
Other examples are
$ sudo ./attack-graph-generator.sh ./examples/javaee
$ sudo ./attack-graph-generator.sh ./examples/example
$ sudo ./attack-graph-generator.sh ./examples/netflix-oss-example
- Please note that on the first try, Clair populates the database, so that is why the attack graph will be empty. Furthermore, building the images in the vulnerability-parser for the first time takes longer. The code is tested on a virtual machine running on the above-mentioned operating system.
The config file is the main point where the attack graphs can be customized. The attack graph generation can be conducted in either online or offline mode. Online mode uses Clair for vulnerabilities detection and takes more time. Offline mode uses already created vulnerability files (by Clair) and performs the attack graph analysis. Therefore, the offline mode does not require an internet connection. Because the edges can have many vulnerabilities, there is an option if we want to display the attack graph with separate edges with different vulnerabilities or combine all of them in one edge. Another option is to display only one vulnerability per edge in the attack graph. Finally, the user has to possibility to modify the pre- and postcondition rules from which the attack graphs are created. For additional details on how to use the config file, please refer to the comments in the config.yml file.
- Stevica Bozhinoski [email protected]
- Amjad Ibrahim, M.Sc. [email protected]
We would like to thank the teams of Clair and Clairctl for their vulnerabilities generator, which is an integral part of our system. Additional thanks to the contributors of all of the third-party tools used in this project.