CTFs as you need them
 
 
 
 
Go to file
Kevin Chung d59bfa3578
Mark 2.2.3 (#1222)
2.2.3 / 2020-01-21
==================

### This release includes a critical security fix for CTFd versions >= 2.0.0

All CTFd administrators are recommended to take the following steps:
1. Upgrade their installations to the latest version
2. Rotate the `SECRET_KEY` value
3. Reset the passwords for all administrator users

**Security**
* This release includes a fix for a vulnerability allowing an arbitrary user to take over other accounts given their username and a CTFd instance with emails enabled

**General**
* Users will receive an email notification when their passwords are reset
* Fixed an error when users provided incorrect team join information
2020-01-21 00:06:03 -05:00
.github Issue template (#455) 2017-11-14 16:40:36 -05:00
CTFd Mark 2.2.3 (#1222) 2020-01-21 00:06:03 -05:00
docs Mark 2.2.3 (#1222) 2020-01-21 00:06:03 -05:00
migrations 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
scripts Fix several issues in Vagrant provisioning (#1046) 2019-09-08 13:04:48 -04:00
tests Strip spaces on registration and have reset password use email address instead of names (#1218) 2020-01-20 14:22:06 -05:00
.codecov.yml Fix admin cannot modify verified status in Edit User (#777) 2018-12-04 00:35:51 -05:00
.dockerignore Adding .dockerignore and making docker-entrypoint consider DATABASE_URL (#312) 2017-07-13 02:43:17 -04:00
.flaskenv 1.2.0 (#627) 2018-05-03 18:04:39 -04:00
.gitignore 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
.prettierignore Format all the things (#991) 2019-05-11 21:09:37 -04:00
.travis.yml 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
CHANGELOG.md Mark 2.2.3 (#1222) 2020-01-21 00:06:03 -05:00
CONTRIBUTING.md Documentation improvements (#963) 2019-04-21 12:00:21 -04:00
Dockerfile 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
LICENSE Update LICENSE 2018-07-29 03:16:54 -04:00
Makefile 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
README.md Remove CTFd Slack references in README to reference MLC Discourse (#1204) 2020-01-03 23:07:46 -05:00
Vagrantfile Fix several issues in Vagrant provisioning (#1046) 2019-09-08 13:04:48 -04:00
development.txt Improve caching (#1014) 2019-06-15 02:07:24 -04:00
docker-compose.yml Make ctfd user usable for mysql connection (#1028) 2019-06-21 00:55:44 -04:00
docker-entrypoint.sh Use /dev/shm for worker-tmp-dir in gunicorn in Docker (#1003) 2019-05-25 01:25:24 -04:00
export.py 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
import.py 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
manage.py 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
package.json Mark 2.2.3 (#1222) 2020-01-21 00:06:03 -05:00
populate.py 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
prepare.sh Fix several issues in Vagrant provisioning (#1046) 2019-09-08 13:04:48 -04:00
requirements.txt 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
serve.py 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00
setup.cfg Starting to write tests 2017-01-07 02:44:31 -05:00
webpack.config.js Seperate out admin theme from core more to fix #1200 (#1202) 2020-01-03 22:18:05 -05:00
wsgi.py Fix flask run by not monkey patching for gevent in wsgi.py (#1101) 2019-09-05 19:50:52 -04:00
yarn.lock 2.2.0 (#1188) 2019-12-22 23:17:34 -05:00

README.md

Build Status MajorLeagueCyber Discourse Documentation Status

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.

CTFd is a CTF in a can.

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.py to your liking.
  3. Use 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 wiki 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: MajorLeagueCyber Discourse

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