JohnHammond
/
CTFd
mirror of https://github.com/JohnHammond/CTFd.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CTFs as you need them
524 Commits
36 Branches
35 Tags
16 MiB
JavaScript 90.2%
Python 7.2%
HTML 2.3%
SCSS 0.2%
 
 
 
 
Go to file
Raihan Ramadistra 64b96d9c1a Fix admin cannot modify verified status in Edit User (#777) 
* Grant admin write access to verified field in UserSchema.
* Add test admin can view and modify verified status
* Add test for creating users with settings
* Add codecov threshold for test failures
 		2018-12-04 00:35:51 -05:00
.github Issue template (#455) 2017-11-14 16:40:36 -05:00
CTFd Fix admin cannot modify verified status in Edit User (#777) 2018-12-04 00:35:51 -05:00
migrations Fix wrong column name in upgrade script (#764) 2018-11-29 20:05:33 -05:00
scripts Add Vagrant with docker support (#285) (#355) 2017-08-20 19:31:32 -04:00
tests Fix admin cannot modify verified status in Edit User (#777) 2018-12-04 00:35:51 -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 Add plugin wrappers for plugin related utils functions (#410) 2017-10-14 17:17:06 -04:00
.travis.yml Fix Uploaders to work with imports/exports (#749) 2018-11-23 06:10:33 -05:00
CHANGELOG.md Update CHANGELOG (#775) 2018-12-02 11:54:48 -05:00
Dockerfile 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
LICENSE Update LICENSE 2018-07-29 03:16:54 -04:00
README.md Mark 2.0.0 (#757) 2018-11-26 20:32:04 -05:00
Vagrantfile Vagrant uses mariadb database rather than sqlite - Fixes #648 (#649) 2018-07-29 00:08:05 -07:00
development.txt 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
docker-compose.yml Update mariadb to 10.4 based on #726 (#762) 2018-11-28 00:57:54 -05:00
docker-entrypoint.sh 2.0.0 (#741) 2018-11-19 23:16:14 -05: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
populate.py 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
prepare.sh Mark prepare.sh executable 2017-09-27 22:32:01 -04:00
requirements.txt 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
serve.py 2.0.0 (#741) 2018-11-19 23:16:14 -05:00
setup.cfg Starting to write tests 2017-01-07 02:44:31 -05:00
wsgi.py 1.2.0 (#627) 2018-05-03 18:04:39 -04:00

README.md

Build Status CTFd Slack

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 CTFd Slack Community: CTFd Slack

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