Submission server/infrastructure for the SRS challenge at FIC https://fic.srs.epita.fr/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
nemunaire 48895af3e8 ui: Don't change page title if challenge info are not loaded 18 hours ago
admin admin: Make menu items active on rights pages 22 hours ago
backend settings: Rename struct to remove FIC occurence 4 weeks ago
configs Distribute and handle challenge.json 4 weeks ago
dashboard Distribute and handle challenge.json 4 weeks ago
fickit-pkg fickit: Limit to amd64 arch 9 months ago
frontend ui: Don't change page title if challenge info are not loaded 18 hours ago
libfic old fix 22 hours ago
password_paper password_paper: Update LaTeX 9 months ago
qa Use pointer receiver more offen 6 months ago
remote/scores-sync-zqds score-sync-zqds: It works! + some optimizations 9 months ago
repochecker repochecker: Revert binary file checks 3 weeks ago
settings settings: Save future changes in a dedicated file 22 hours ago
udev udev: ready to FIC2019 3 years ago
.drone-manifest-fic-admin.yml CI: create Docker manifest image 1 year ago
.drone-manifest-fic-backend.yml CD: Fix deployment of fic-backend image 10 months ago
.drone-manifest-fic-dashboard.yml CI: create Docker manifest image 1 year ago
.drone-manifest-fic-frontend.yml CI: create Docker manifest image 1 year ago
.drone-manifest-fic-nginx.yml Introduce fic-nginx 10 months ago
.drone-manifest-fic-qa.yml CI: create Docker manifest image 1 year ago
.drone-manifest-fic-repochecker.yml CI: add Dockerfile for repochecker (used for student's CI) 1 year ago
.drone.yml CI: Fix compilation with go 1.18 2 months ago
.gitignore Update .gitignore 9 months ago
Dockerfile-admin CI: Fix compilation with go 1.18 2 months ago
Dockerfile-backend CI: Fix compilation with go 1.18 2 months ago
Dockerfile-dashboard CI: Fix compilation with go 1.18 2 months ago
Dockerfile-frontend CI: Fix compilation with go 1.18 2 months ago
Dockerfile-frontend-ui CI: Add Dockerfile just containing the ui files 9 months ago
Dockerfile-nginx configs: Rework nginx configs 9 months ago
Dockerfile-qa CI: Fix compilation with go 1.18 2 months ago
Dockerfile-remote-scores-sync-zqds Distribute and handle challenge.json 4 weeks ago
Dockerfile-repochecker Pass hadolint 6 months ago
LICENSE Add LICENSE: chose MIT 4 years ago
README.md Update README.md 9 months ago
docker-compose.yml configs: Update scripts and config for new ui 9 months ago
entrypoint-frontend.sh configs: Update scripts and config for new ui 9 months ago
fickit-backend.yml admin: Add setting to differenciate real challenge from common tests 4 months ago
fickit-boot.yml fickit: Update kernel config used for 2021 9 months ago
fickit-frontend.yml fickit: IP setup 2021 9 months ago
fickit-prepare.yml fickit: Update kernel config used for 2021 9 months ago
fickit-update.yml Refactor fickit-update and fickit-prepare 2 years ago
go.mod chore(deps): update module github.com/yuin/goldmark to v1.4.12 22 hours ago
go.sum chore(deps): update module github.com/yuin/goldmark to v1.4.12 22 hours ago
htdocs-admin admin: Embed static assets into binary 12 months ago
htdocs-dashboard dashboard: came back online 4 years ago
htdocs-qa qa: New service to handle QA testing by students 2 years ago
qa-fill-todo.sh QA: Add new script to migrate QA content from a DB to another 1 year ago
qa-fill-view.sh QA: Add new script to migrate QA content from a DB to another 1 year ago
qa-merge-db.sh QA: Add new script to migrate QA content from a DB to another 1 year ago
renovate.json renovate: Automerge some go packages 4 months ago

README.md

FIC Forensic CTF Platform

This is a CTF server for distributing and validating challenges. It is design to be robust, so it uses some uncommon technics like client certificate for authentication, lots of state of the art cryptographic methods and aims to be deployed in a DMZ network architecture.

This is a monorepo, containing several micro-services :

  • admin is the web interface and API used to control the challenge and doing synchronization.
  • backend is an inotify reacting service that handles submissions checking and team's files generation.
  • dashboard is a public interface to explain and follow the conquest, aims to animate the challenge for visitors.
  • frontend is only responsible for receiving submissions. It is the only dynamic part accessibe to players, so it's codebase is reduce to the minimum. It does not parse or try to understand players submissions, it just write it down to a file in the file system. Parsing and treatment is made by the backend.
  • qa is an interface dedicated to challenge development, it stores reports to be treated by challenges creators.
  • remote/scores-sync-zqds is an inotify reacting service that allows us to synchronize scores with the ZQDS scoring platform.
  • repochecker is a side project to check offline for synchronization issues.

In the production setup, each micro-service runs in a dedicated container, isolated from each other. Moreover, two physical machines should be used:

  • deimos communicates with players: displaying the web interface, authenticate teams and players, storing contest files and handling submissions retrieval without understanding them. It can't access phobos so its job stop after writing requests on the filesystem.
  • phobos is hidden from players, isolated from the network. It can only access deimos via a restricted ssh connection, to retrieve requests from deimos filesystem and pushing to it newly generated static files.

So, the general filesystem is organized this way:

  • DASHBOARD contains files structuring the content of the dashboard screen(s).
  • FILES stores the contest file to be downloaded by players. To be accessible without authentication and to avoid bruteforce, each file is placed into a directory with a hashed name (the original file name is preserved). It's rsynced as is to deimos.
  • PKI takes care of the PKI used for the client certiciate authorization process, and more generaly, all authentication related files (htpasswd, dexidp config, ...). Only the shared subdirectory is shared with deimos, private key and teams P12 don't go out.
  • SETTINGS stores the challenge config as wanted by admins. It's not always the config in use: it uses can be delayed waiting for a trigger.
  • SETTINGSDIST is the challenge configuration in use. It is the one shared with players.
  • startingblock keep the started state of the challenge. This helps nginx to know when it can start distributing exercices related files.
  • TEAMS stores the static files generated by the backend, there is one subdirectory by team (id of the team), plus some files at the root, which are common to all teams. There is also symlink pointing to team directory, each symlink represent an authentication association (certificate ID, OpenID username, htpasswd user, ...).
  • submissions is the directory where the frontend writes requests. It creates subdirectories at the name of the authentication association, as seen in TEAMS, backend then resolve the association regarding TEAMS directory. There is also a special directory to handle team registration.

Local developer setup

Using Docker

Use docker-compose build, then docker-compose up to launch the infrastructure.

After booting, you'll be able to reach the main interface at: http://localhost:8042/ and the admin one at: http://localhost:8081/.

Import folder

Local import folder

The following changes is only required if your are trying to change the local import folder ~/fic location.

Make the following changes inside this file docker-compose.yml:

23    volumes:
24 -     - ~/fic:/mnt/fic:ro
24 +     - <custom-path-to-import-folder>/fic:/mnt/fic:ro
Owncloud import folder

If your are trying to use the folder available with the Owncloud service, make the following changes inside this file docker-compose.yml:

29 -    command: --baseurl /admin/ -localimport /mnt/fic -localimportsymlink
29 +    command: --baseurl /admin/ -clouddav=https://owncloud.srs.epita.fr/remote.php/webdav/FIC%202019/ -clouduser <login_x> -cloudpass '<passwd>'

Manual builds

Running this project requires a web server (configuration is given for nginx), a database (currently supporting only MySQL/MariaDB), a Go compiler for the revision 1.16 at least and a inotify-aware system.

  1. First, you'll need to retrieve the dependencies:

     go mod vendor
    
  2. Then, build the three Go projects:

     go build -o fic-admin ./admin
     go build -o fic-backend ./backend
     go build -o fic-dashboard ./dashboard
     go build -o fic-frontend ./frontend
     go build -o fic-qa ./qa
     go build -o fic-repochecker ./repochecker
     ...
    
  3. Before launching anything, you need to create a database:

     mysql -u root -p <<EOF
     CREATE DATABASE fic;
     CREATE USER fic@localhost IDENTIFIED BY 'fic';
     GRANT ALL ON fic.* TO fic@localhost;
     EOF
    

    By default, expected credentials for development purpose is fic, for both username, password and database name. If you want to use other credentials, define the corresponding environment variable: MYSQL_HOST, MYSQL_USER, MYSQL_PASSWORD and MYSQL_DATABASE. Those variables are the one used by the mysql docker image, so just link them together if you use containers.

  4. Launch it!

     ./fic-admin &
    

    After initializing the database, the server will listen on http://localhost:8081/: this is the administration part.

     ./fic-backend &
    

    This daemon generates static and team related files and then waits for new submissions (expected in submissions directory). It only watchs modifications on the file system, it has no web interface.

     ./fic-frontend &
    

    This one exposes an API that gives time synchronization to clients and handle submission reception (but without treating them).

     ./fic-dashboard &
    

    This last server runs the public dashboard. It serves all file, without the need of a webserver. It listens on port 8082 by default.

For the moment, a web server is mandatory to serve static files, look at the samples given in the configs/nginx directory. You need to pick one base configation flavor in the configs/nginx/base directory, and associated with an authentication mechanism in configs/nginx/auth (named the file fic-auth.conf in /etc/nginx), and also pick the corresponding configs/nginx/get-team file, you named fic-get-team.conf.