Skip to content

A fast, efficient and lightweight (~100 KB) Capture The Flag framework inspired by the HackTheBox platform. Built with Flask.

License

Notifications You must be signed in to change notification settings

Sayoni26/RTB-CTF-Framework

This branch is 25 commits behind abs0lut3pwn4g3/RTB-CTF-Framework:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

feb53ca Β· May 3, 2020
Apr 11, 2020
May 3, 2020
May 2, 2020
Jul 27, 2019
Apr 12, 2020
May 1, 2020
Apr 19, 2020
May 1, 2020
May 2, 2020
Apr 19, 2020
Feb 23, 2020
Mar 6, 2020
May 3, 2020
Apr 28, 2020
May 2, 2020
May 1, 2020
Mar 6, 2020
May 1, 2020
Apr 19, 2020
Apr 19, 2020

Repository files navigation

RootTheBox CTF Framework

Rawsec's CyberSecurity Inventory

Build Status Language grade: Python Code style: black

A fast, efficient and lightweight (~100 KB) Capture The Flag framework (in Flask) inspired by the HackTheBox platform.

The 100 second elevator-pitch is that: A Capture The Flag framework; one that is fast yet feature packed, efficient thus scalable, lightweight (insert some more pro developer adjectives) and customizable to your organization's brand while not emptying your bank A/C.

Want to see it in action?

A live demo of the app is available at: https://rtblivedemo.herokuapp.com/.

You can login and mess around as the admin user admin:admin (i.e. username:password combinations) or register your own.

Features

  • Machines listing with fields: name, IP, OS, points and difficulty level.
  • Challenges listing with fields: title, description, URL, points.
  • Totally configurable settings such as running time, organization details, CTF name, etc.
  • Automatic strong password for administrator
  • Well implemented controls for administrators providing features such as issuing notifications, database CRUD operations, full fledged logging,
  • Simple User Registration/login process, account management, Forgot password functionalities,
  • Flag submission (currently 2 flags: user and root),
  • Real time scoreboard tracking,
  • Efficient caching so it's fast
  • Easily deployable on Heroku.

Build locally

Please see INSTALLATION.md.

Host a customized CTF with Heroku for free in under a minute

  1. Sign up on Heroku, if you haven't already and click on the below "Deploy to Heroku" button.

    Deploy

  2. Give your application an awesome name and optionally specify mail environment variables.

    Note: A psuedo-random password for the admin user would be created and set in the config variable ADMIN_PASS. On Heroku, you can reveal this password from your application's dashboard settings. Same for the Flask application's SECRET_KEY.

  3. Open your newly deployed application in the browser, you'll be redirected to login as the admin user and do so.

  4. Finally, you'll want to /setup the CTF Settings and,

Yay! Now you have a customized instance of the RTB-CTF-Framework live on Heroku. πŸŽ‰

Bonus: You can manage the database CRUD operations from admin views GUI; change machine settings, issue notifications to users, etc.

Inspiration

The main purpose of this project is to serve as a scoring engine and CTF manager. One that is packed with features, can handle enterprise/global level traffic on a scalable yet free heroku's dyno.

CTFd is one of the most popular CTF framework and we have used it for multiple engagements and will surely use it again. But at the same time, CTFd is heavy (~22.2 mb) (it gives poor performance even on a 49 / m o h e r o k u d y n o ) a n d n o t e v e r y b o d y h a s $$ to spend on cloud, especially students (like us). So, that's where RTB-CTF-Framework (~100 KB) comes in.

Contributing

GitHub contributors GitHub issues by-label

πŸ‘¨ Project Owner
πŸ‘¬ Mentors
Slack Channel for GSSoC 2020

For further guidelines, Please refer to CONTRIBUTING.md

Live Demo

Live Demo: https://rtblivedemo.herokuapp.com/ (login with admin:admin)

About

A fast, efficient and lightweight (~100 KB) Capture The Flag framework inspired by the HackTheBox platform. Built with Flask.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 62.0%
  • HTML 32.3%
  • CSS 3.9%
  • Other 1.8%