https://github.com/offsecginger/CTFd-Docker-Challenges

Docker Challenge creation for CTFd. Allows per team/user containers!
https://github.com/offsecginger/CTFd-Docker-Challenges

Last synced: 21 days ago
JSON representation

Docker Challenge creation for CTFd. Allows per team/user containers!

• Host: GitHub
• URL: https://github.com/offsecginger/CTFd-Docker-Challenges
• Owner: offsecginger
• License: gpl-3.0
• Created: 2020-05-04T17:21:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-20T18:59:40.000Z (12 months ago)
• Last Synced: 2024-08-05T17:45:05.768Z (4 months ago)
• Language: Python
• Size: 62.5 KB
• Stars: 77
• Watchers: 4
• Forks: 51
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - offsecginger/CTFd-Docker-Challenges - Docker Challenge creation for CTFd. Allows per team/user containers! (Python)

README

        
# CTFd Docker Plugin

This plugin for CTFd will allow your competing teams/users to start dockerized images for presented challenges. It adds a challenge type "docker" that can be assigned a specific docker image/tag. A few notable requirements:

* Docker Config must be set first. You can access this via `/admin/docker_config`. Currently supported config is pure http (no encryption/authentication) or full TLS with client certificate validation. Configuration information for TLS can be found here: https://docs.docker.com/engine/security/https/

* This plugin is written so that challenges are stored by tags. For example, StormCTF stores all docker challenges for InfoSeCon2019 in the `stormctf/infosecon2019` repository. A challenge example would be `stormctf/infosecon2019:arbit`. This is how you would call the challenge when creating a new challenge.

## Important Notes

* It is unknown if using the same tag twice will cause issues. This plugin was written to avoid this issue, but it has not been fully tested.

* As with all plugins, please security test your Scoreboard before launching the CTF. This plugin has been tested and vetted in the StormCTF environment, but yours may vary.

* In 2.3.3 a CTFd Configuration change is **REQUIRED**. Specifically, https://github.com/CTFd/CTFd/issues/1370. You will need to replace the function `get_configurable_plugins` with the one in the solution. This allows `config.json` to be a list, which allows multiple Menu items per plugin for the Plugins dropdown. You may want to change any other plugins you install to accommodate this. It's as simple as enclosing the curly braces with square braces. Example below.

```

# Original config.json

{

	"name": "Another Plugin",

	"route": "/admin/plugin/route"

}

```

```

# Modified config.json

[{

	"name": "Another Plugin",

	"route": "/admin/plugin/route"

}]

```

**NOTE: The above config.json modification only applies to OTHER plugins installed.**

*Requires flask_wtf*

`pip install flask_wtf`

## Features

* Allows players to create their own docker container for docker challenges.

* 5 minute revert timer.

* 2 hour stale container nuke.

* Status panel for Admins to manage docker containers currently active.

* Support for client side validation TLS docker api connections (HIGHLY RECOMMENDED).

* Docker container kill on solve.

* (Mostly) Seamless integration with CTFd.

* **Untested**: _Should_ be able to seamlessly integrate with other challenge types.

## Installation / Configuration

* Make the above required code change in CTFd 2.3.3 (`get_configurable_plugins`).

* Drop the folder `docker_challenges` into `CTFd/CTFd/plugins` (Exactly this name).

* Restart CTFd.

* Navigate to `/admin/docker_config`. Add your configuration information. Click Submit.

* Add your required repositories for this CTF. You can select multiple by holding CTRL when clicking. Click Submit.

* Click Challenges, Select `docker` for challenge type. Create a challenge as normal, but select the correct docker tag for this challenge.

* Double check the front end shows "Start Docker Instance" on the challenge.

* Confirm users are able to start/revert and access docker challenges.

* Host an awesome CTF!

### Update: 20210206

Works with 3.2.1

* Updated the entire plugin to work with the new CTFd.

#### Credits

* https://github.com/offsecginger (Twitter: @offsec_ginger)

* Jaime Geiger (For Original Plugin assistance) (Twitter: @jgeigerm)