readme: preparing for public release

README.md

-CTF Anti cheat
+CTF Infrastructure
 ==========
+
+This project is a full blown CTF infrastructure, aiming to integrate with CTFd
+as a frontend. It includes:
+
+* A server side infrastructure built in NixOS
+* A suite of challenges that are unique, tested and whose solution is auto-generated
+* An anti cheat system to prevent flag sharing between teams 
+
+# Anti Cheat
+
 This is a deterministic anti-cheat/unique binaries generator specially tailored
-to CTFs. It creates a regex per challenge to load into your flag platform. 
+to CTFs. It creates a regex per challenge to load into CTFd. 
 The flag itself is a sha2 of the challenge name plus a secret on top of 4 bytes
 at a different position for each challenge identifying uniquely the team in a
-sneaky fashion.   
+sneaky fashion. 
+
+# Challenge generation
+
 The setup also includes ways to add junk code to binaries and have more
 convoluted setup done to them through a python script.  
 All the flags and binaries are deterministic, so as long as you don't re-roll
@@ -15,8 +28,10 @@ cannot be found. The whole idea is to have hashes that looks the most alike
 possible while still being fairly certain about the origin of said flag.
 
 ## Setup:
-Put your challengess in  the folder called "chals". One folder per challenge, each folder must contain
-a setup.py setting up the challenge final folder and removing unecessary files.  
+
+Put your challengess in  the folder called "chals". 
+One folder per challenge, each folder must contain a setup.py setting up the challenge 
+final folder and removing unecessary files.  
 You will end up with a folder tree such as:
 ```
 chals_out/
@@ -29,12 +44,23 @@ chals_out/
 │       ├── access_security
 │       └── flag.txt
 ```
-You can thus automate deployment of the binaries onto your VMs however you like.  
+
+You can then call the `gen_chals.py` script which will take a partial export of
+a CTFd database to generate each of your challenge per team. You'll find the
+result in the folder `chals_out`. You can then use those challenges with the
+infrastructure directly, and the regex.txt generated in CTFd to validate the
+flags.
+
+You can thus automate deployment of the binaries onto your VMs however you like. 
 This setup works well with binaries that won't be executed remotely too and whatnot.
 
 
 ## RE CTF Edition:
-challenges list: 
+
+This CTF includes the challenges made for the class "Reverse Engineering and
+Binary exploitation" I taught for the École Supérieure de Génie Informatique, or
+ESGI. The challenges included are:
+
 - reverse_rop
 - simple_rop
 - simple_rop_2
@@ -44,3 +70,12 @@ challenges list:
 - access_security
 - web_server_2
 - modern_rop
+
+## Credits
+
+This CTF infrastructure was made as a part of a class that I taught,
+I being Gauvain Roussel-Tarbouriech, also commonly known as "GovanifY".
+I made all the challenges, build system and anti cheat.
+
+Ryan Lahfa made the original infrastructure work in a night(!) along with me,
+which I later improved before deploying it. Huge thanks goes to him!