Skip to content

Commit

Permalink
update readme (+fr)
Browse files Browse the repository at this point in the history
  • Loading branch information
Francois Lesueur committed Oct 27, 2021
1 parent 5307149 commit e8bcb02
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ It is based on the infrastructure-as-code principle: these scripts programmatica

Example practical work using this environment (in french) :

* [Intrusion scenario](https://github.com/flesueur/srs/blob/master/tp1-intrusion.md) (adapted to MI-LXC v1.3.0)
* [Intrusion scenario](https://git.kaz.bzh/francois.lesueur/LPCyber/src/branch/master/tp1-intrusion.md) (adapted to MI-LXC v1.4.0)
* [Firewall](https://github.com/flesueur/srs/blob/master/tp2-firewall.md) (adapted to MI-LXC v1.3.0)
* [IDS](https://github.com/flesueur/srs/blob/master/tp3-ids.md) (adapted to MI-LXC v1.3.0)
* [IDS](https://git.kaz.bzh/francois.lesueur/LPCyber/src/branch/master/tp2-idps.md) (adapted to MI-LXC v1.4.0)
* [CA](https://github.com/flesueur/csc/blob/master/tp1-https.md) (adapted to MI-LXC v1.3.0)
* [MI-LXC walkthrough](https://git.kaz.bzh/francois.lesueur/M3102/src/branch/master/td1.1-milxc.md) (adapted to MI-LXC v1.4.0)

There is also a [walkthrough tutorial](doc/TUTORIAL.md) and a [video](https://www.youtube.com/watch?v=waCsmE7BeZs).

Expand All @@ -22,7 +23,7 @@ There is also a [walkthrough tutorial](doc/TUTORIAL.md) and a [video](https://ww

Features :

* Containers run up-to-date Debian Buster or Alpine Linux
* Containers run up-to-date Debian Bullseye or Alpine Linux
* The infrastructure-as-code principle allows for easy management, deployment and evolution along time
* The infrastructure is built by final users on their own PC
* Every container also have access to the real internet (for software installation)
Expand All @@ -35,7 +36,6 @@ The example network is composed of :
* some residential ISP clients (hacker and a random PC), using mail adresses \@isp-a.milxc
* a target organization, owning its own AS number, running classical services (HTTP, mail, DNS, filer, NIS, clients, etc.) for target.milxc domain
* a certification authority (MICA) ready for ACME (Let's Encrypt-style)
* MISP instances on misp.target.milxc (on target-dmz) and misp.gozilla.milxc (on gozilla-infra)

A few things you can do and observe :

Expand Down Expand Up @@ -100,7 +100,9 @@ Finally, hosts are described and provisonned through:
* host templates in `templates/hosts/<family>/<template>/provision.sh`, which typically provide templates for BGP routers, mail servers, mail clients, ...
* specific scripts for a given host in `groups/<groupname>/<hostname>/provision.sh`

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 (all BGP-related configuration is specified in `global.json`)
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 (all BGP-related configuration is specified in `global.json`).

This process is described in the [walkthrough tutorial](doc/TUTORIAL.md).


# License
Expand Down
10 changes: 6 additions & 4 deletions doc/README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Il est basé sur le principe de l'infrastructure en tant que code : ces scripts

Exemple de travaux pratiques utilisant cet environnement :

* [Intrusion scenario](https://github.com/flesueur/srs/blob/master/tp1-intrusion.md) (adapté à MI-LXC v1.3.0)
* [Intrusion scenario](https://git.kaz.bzh/francois.lesueur/LPCyber/src/branch/master/tp1-intrusion.md) (adapté à MI-LXC v1.4.0)
* [Firewall](https://github.com/flesueur/srs/blob/master/tp2-firewall.md) (adapté à MI-LXC v1.3.0)
* [IDS](https://github.com/flesueur/srs/blob/master/tp3-ids.md) (adapté à MI-LXC v1.3.0)
* [IDS](https://git.kaz.bzh/francois.lesueur/LPCyber/src/branch/master/tp2-idps.md) (adapté à MI-LXC v1.4.0)
* [CA](https://github.com/flesueur/csc/blob/master/tp1-https.md) (adapté à MI-LXC v1.3.0)
* [Découverte MI-LXC](https://git.kaz.bzh/francois.lesueur/M3102/src/branch/master/td1.1-milxc.md) (adapté à MI-LXC v1.4.0)

Il existe également un [tutoriel pas à pas](TUTORIAL.fr.md) et une [vidéo de présentation](https://www.sstic.org/2020/presentation/mi-lxc_une_plateforme_pedagogique_pour_la_securite_reseau/).

Expand All @@ -22,7 +23,7 @@ Il existe également un [tutoriel pas à pas](TUTORIAL.fr.md) et une [vidéo de

Fonctionnalités :

* Les conteneurs fonctionnent avec les dernières versions de Debian Buster ou Alpine Linux.
* Les conteneurs fonctionnent avec les dernières versions de Debian Bullseye ou Alpine Linux.
* Le principe de l'infrastructure en tant que code permet une gestion, un déploiement et une évolution faciles dans le temps.
* L'infrastructure est construite par les utilisateurs finaux sur leur propre PC.
* Chaque conteneur a également accès à l'Internet réel (pour l'installation de logiciels).
Expand All @@ -35,7 +36,6 @@ Le réseau d'exemple est composé de :
* quelques clients ISP résidentiels (le pirate et un PC aléatoire), utilisant les adresses de courrier \@isp-a.milxc
* une organisation cible, possédant son propre numéro d'AS, exécutant des services classiques (HTTP, courrier, DNS, filer, NIS, clients, etc.) pour le domaine target.milxc.
* Une autorité de certification (MICA) prête pour ACME (style Let's Encrypt).
* Des instances MISP sur misp.target.milxc (sur target-dmz) et misp.gozilla.milxc (sur gozilla-infra).

Quelques éléments que vous pouvez faire et observer :

Expand Down Expand Up @@ -104,6 +104,8 @@ Enfin, les hôtes sont décrits et fournis à travers :

Pour l'étendre, vous pouvez soit étendre un AS existant (typiquement, Target), soit créer un nouvel AS. Dans ce deuxième cas, vous pouvez dupliquer Target et le connecter à un opérateur de transit sous un nouveau numéro d'AS (toute la configuration relative à BGP est spécifiée dans `global.json`).

Ce processus est décrit dans le [tutoriel pas à pas](doc/TUTORIAL.fr.md).


# Licence
Ce logiciel est sous licence AGPLv3 : vous pouvez le réutiliser librement à condition d'écrire que vous l'utilisez et de redistribuer vos modifications. Des licences spéciales avec (encore) plus de libertés pour les activités d'enseignement public peuvent être discutées.

0 comments on commit e8bcb02

Please sign in to comment.