What is CTFd?

CTFd is a Capture The Flag framework focusing on ease of use and customizability. It comes with everything you need to run a CTF and it's easy to customize with plugins and themes.

Features

• Create your own challenges, categories, hints, and flags from the Admin Interface
  • Dynamic Scoring Challenges
  • Unlockable challenge support
  • Challenge plugin architecture to create your own custom challenges
  • Static & Regex based flags
    • Custom flag plugins
  • Unlockable hints
  • File uploads to the server or an Amazon S3-compatible backend
  • Limit challenge attempts & hide challenges
  • Automatic bruteforce protection
• Individual and Team based competitions
  • Have users play on their own or form teams to play together
• Scoreboard with automatic tie resolution
  • Hide Scores from the public
  • Freeze Scores at a specific time
• Scoregraphs comparing the top 10 teams and team progress graphs
• Markdown content management system
• SMTP + Mailgun email support
  • Email confirmation support
  • Forgot password support
• Automatic competition starting and ending
• Team management, hiding, and banning
• Customize everything using the plugin and theme interfaces
• Importing and Exporting of CTF data for archival
• And a lot more...

Install

1. Install dependencies: pip install -r requirements.txt
   1. You can also use the prepare.sh script to install system dependencies using apt.
2. Modify CTFd/config.ini to your liking.
3. Use python serve.py or flask run in a terminal to drop into debug mode.

You can use the auto-generated Docker images with the following command:

docker run -p 8000:8000 -it ctfd/ctfd

Or you can use Docker Compose with the following command from the source repository:

docker-compose up

Check out the CTFd docs for deployment options and the Getting Started guide

Live Demo

https://demo.ctfd.io/

Support

To get basic support, you can join the MajorLeagueCyber Community:

If you prefer commercial support or have a special project, feel free to contact us.

Managed Hosting

Looking to use CTFd but don't want to deal with managing infrastructure? Check out the CTFd website for managed CTFd deployments.

MajorLeagueCyber

CTFd is heavily integrated with MajorLeagueCyber. MajorLeagueCyber (MLC) is a CTF stats tracker that provides event scheduling, team tracking, and single sign on for events.

By registering your CTF event with MajorLeagueCyber users can automatically login, track their individual and team scores, submit writeups, and get notifications of important events.

To integrate with MajorLeagueCyber, simply register an account, create an event, and install the client ID and client secret in the relevant portion in CTFd/config.py or in the admin panel:

OAUTH_CLIENT_ID = None
OAUTH_CLIENT_SECRET = None

Credits

• Logo by Laura Barbera
• Theme by Christopher Thompson
• Notification Sound by Terrence Martin

CTFd-docker-deploy

Repository to deploy CTFd using docker.

Note that this is currently pinned to the stable version 3.0.0 of CTFd

Brief instructions follow but you can also refer to a blogpost about how I used this setup .

How to use this repository to start a CTFd instance without TLS

1. Clone this repository by running git clone https://github.com/tghosth/CTFd-docker-deploy.git.
2. Go into the directory which the repository was cloned into (CTFd-docker-deploy by default)
3. Either:
   1. Install docker based on the instructions here.
   2. Install docker-compose based on the instructions here.
   3. Copy the contents of the https://github.com/CTFd/CTFd repository into this CTFd-docker-deploy folder.
4. Or:
   1. Run the setupenv.sh script from this folder.
5. Run run.sh or docker-compose up.

How to use this repository to start a CTFd instance with TLS

1. Follow steps 1 to 4 from the previous section.
2. Setup your DNS records to point to the server where you are starting CTFd.
3. Get a TLS certificate and private key from a Certificate Authority and save them as cert.pem and privkey.pem respectively in the ssl directory in your cloned repository.
4. Edit the hostname line in the docker-compose-production.yml file to match the hostname you have defined to point to this server.
5. Run run-tls.sh or docker-compose -f docker-compose.yml -f docker-compose-production.yml up.