blob: 89b2017f07851dd26a4419e7ab7f6b925580c6eb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# circus-companion
The companion ~cube~ container spawned specifically for one user.
## Purpose
- Validator for flags
- Temporary secret vault for the user
- control endpoint of challenge containers for the user
## Usage
This executable needs some parameters to work properly:
| Key | Required? | Description |
|---|---|---|
| `-port` | No | The port for HTTP. *Default: 8080* |
| `-username` | No | Name of our user, as used e.g. in salutation. No length or charset limitation. *Default: Player 1* |
| `-accessCode` | Yes | Access code for the user. *Default: AllYourCodesAreBelongToUs* |
| `-sessionSalt` | Yes | Variable to salt the session token generator with. |
| `-seedFile` | Yes | JSON file to read challenge information from. |
## Seed file
The seed file should be of the following format:
```
{
"challenges": [
{
"name": "Evil Service",
"description": "A meaningful and funny description",
"flag": "CIRCUS[IS_REALLY_COOL]",
"container": "challenge-evilservice",
"category": "Miscellaneous"
},
{
"name": "Insecure Stuff",
[...]
]
}
```
|
