about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9dd0da6..b8f6f15 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 # circus-challengeprovider
 
-This container will provide the challenges for the companion container making it possible to dynamically change challenges and host the circus in docker-swarm
\ No newline at end of file
+This container will provide the challenges for the companion container making it possible to dynamically change challenges and host the circus in docker-swarm
+
+## Function
+
+The challengeprovider is part of the docker swarm providing the challenges for
+the individual companion containers.
+The spawned companion containers access the challenge provider, request the
+challenges, recieve them and hosts them for the users.
+
+In order to not transfer the flag over a possibly insecure connection, the
+sha256 sum of the flag is transmitted. The companion containers can verify the
+flag by hashing it (sha256), comparing the hashes and so defining if a challenge
+is solved or not.