flesueur / mi-lxc

Mini-Internet using LXC for practical works
GNU Affero General Public License v3.0
338 stars 24 forks source link

MI-LXC : Mini-Internet using LXC            

fr

MI-LXC uses LXC to simulate an internet-like environment. I use this environment for (infosec) practical work (intrusion, firewall, IDS, etc.). The small memory footprint of LXC combined with differential images allows to run it on modest hardware.

It is based on the infrastructure-as-code principle: these scripts programmatically generate the target environment.

Since version 2.0, MI-LXC uses SNSTER under the hood. Compared to previous monolithic versions, the framework (python code, templates, masters) has been splitted to SNSTER and configuration format has changed (YAML instead of JSON and different organization). This MI-LXC repository now only contains a topology configuration (topology/ subfolder) simulating a mini-internet on top of SNSTER. The vagrant subdirectory creates a ready-to-use VM with both SNSTER and MI-LXC. The releases link to such VMs.

Example practical work using this environment (in french) (note that commands and internals have changed between v1.4.x and v2.x) :

There is also a walkthrough tutorial and a video (the video is related to v1).

Topology

Features and composition

Features :

The example network is composed of :

A few things you can do and observe :

The "IANA-type" numbering (AS numbers, IP space, TLDs) is described in doc/MI-IANA.txt. There is currently no cryptography deployed anywhere (no HTTPS, no IMAPS, no DNSSEC, etc.). This will probably be added at some point but in the meantime, deploying this is part of the expected work from students.

More precise details on what is installed and configured on hosts is in doc/DETAILS.md.

How to use

Installation

You can either:

Usage

The snster script generates and uses containers (as root, since it manipulates bridges and lxc commands, more on this here). It is used as snster <command>, with the following commands:

Command Description
create [name] Creates the [name] container, defaults to create all containers
renet Renets all the containers
destroy [name] Destroys the [name] container, defaults to destroy all containers
destroymaster Destroys all the master containers
updatemaster Updates all the master containers
start Starts the created infrastructure
stop Stops the created infrastructure
attach [user@]<name> [command] Attaches a term on \ as [user](defaults to root) and executes [command](defaults to interactive shell)
display [user@]<name> Displays a graphical desktop on \ as [user](defaults to debian)
print Graphically displays the defined architecture
(\ are mandatory and [arguments] are optional)

There is also a walkthrough tutorial.

How to extend

The address space is explained in MI-IANA.txt and the global topology is defined in topology/. It describes:

Each group of hosts is described through a group.yml file in its subfolder.

Finally, hosts are described and provisonned through:

To extend it, you can either extend an existing AS (typically, Target) or create a new AS. In this second case, you can duplicate Target and then connect it to some transit operator under a new AS number.

This process is described in the walkthrough tutorial.

License

This software is licensed under AGPLv3 : you can freely reuse it as long as you write you use it and you redistribute your modifications. Special licenses with (even) more liberties for public teaching activities can be discussed.