# ctfg

This is a simple Capture-The-Flag game engine.

## Building and Running

You will need to install a few dependencies first.  If you are running homebrew,
run...
```sh
brew install make sbcl ocicl gcc@11
```

Otherwise, install `sbcl` from your OS distribution, and then `ocicl` from source at https://github.com/ocicl/ocicl.

Once `ocicl` is available, run `ocicl install` to download the Common
Lisp dependencies.

And then...

* To build `ctfg`: `make`
* To test `ctfg`: `make check`
* To run `ctfg`: `ctfg --help`

The `--developer-mode` option disables caching of static content, and
reloads the challenges.json every time the Challenge page is
rendered.  This allows you view your changes in real time as you are
developing content.


## Configuring your Game

1. Player credentials should live in a file called `credentials.csv`.  It's a simple `username,password` csv file.

2. Challenges are in `src/challenges.json`.  This should be a json array containing objects like this:
```
        {
            "id": 5,
            "title": "SQL Injection Login",
            "category": "Web",
            "difficulty": "Easy",
            "points": 150,
            "description": "Bypass the login mechanism using SQL injection techniques.",
            "content": "Login page source code: \n    echo \"Login successful! Flag: \" . $flag; \n} else { \n    echo \"Invalid credentials\"; \n}" ,
            "flag": "foo",
            "requirements": [2, 3]
        },
```

  Each challenge needs a unique `id`.  All of the other fields are self-explanatory.  The `requirements` field is optional. It should be a list of challenges that must be solved before this challenge appears on the board.

3. Replace `static/images/banner.png` with your own content.

4. Edit `game-clusters.yaml` to point at the cluster hosting this app,
   as well as the list of player clusters (all possibly the same).
   Users are assigned to the different player clusters in a
   round-robin format as they join.


## Author and License

`ctfg` was written by Anthony Green and is distributed
under the terms of the MIT license.