RTB-CTF-Framework - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #golang #android #rust #deep-learning #nodejs #kubernetes #security #pytorch #mcp #ios

RTB-CTF-Framework

(★ 110)

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

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report_template.md
  - feature_request_template.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- INSTALLATION.md
- pull_request_template.md
- - __init__.py
  - config.py
- create_db.test.py
- docker-entrypoint.sh
- init_db.sh
- populate_db.prod.py
- populate_db.test.py
- requirements.txt
- run.py
- runserver.sh
.dockerignore
.env
.env_postgres
.gitignore
.lgtm.yml
.travis.yml
app.json
docker-compose-for-tests.yml
docker-compose.yml
Dockerfile
LICENSE.AGPL
LICENSE.COMMERCIAL
Procfile
README.md
requirements.txt
rtb_nginx_http
runtime.txt
setup.cfg

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RootTheBox CTF Framework

<p>
  <a href="https://inventory.rawsec.ml/" target="_blank">
    <img height="26px" alt="Rawsec's CyberSecurity Inventory" src="https://inventory.rawsec.ml/img/badges/Rawsec-inventoried-FF5050_for-the-badge.svg">
  </a>
  <img height="26px" src="https://forthebadge.com/images/badges/made-with-python.svg">
</p>
<p style="height:18px">
  <a href="https://travis-ci.com/abs0lut3pwn4g3/RTB-CTF-Framework" target="_blank">
    <img alt="Build Status" src="https://travis-ci.com/abs0lut3pwn4g3/RTB-CTF-Framework.svg?branch=gssoc20-dev"/>
  </a>
  <a href="https://lgtm.com/projects/g/abs0lut3pwn4g3/RTB-CTF-Framework/context:python">
  	<img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/abs0lut3pwn4g3/RTB-CTF-Framework.svg?logo=lgtm&logoWidth=18"/>
  </a>
  <a href="https://github.com/psf/black" target="_blank">
    <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"/>
  </a>
</p>

A fast, efficient and lightweight (~100 KB) Capture The Flag framework (in Flask) inspired by the [HackTheBox](https://hackthebox.eu/) 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://rtbctfframework.up.railway.app/.

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.
* You can manage the database CRUD operations from admin views GUI; change machine settings, issue notifications to users, etc.

## Build locally

Please see [INSTALLATION.md](.github/INSTALLATION.md).

## Host a customized version of RTB-CTF-Framework on the cloud in under a minute

### Railway.app

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/Znjax0?referralCode=t4HzEf)

### Zeet.co

[![Deploy](https://deploy.zeet.co/RTB-CTF-Framework.svg)](https://deploy.zeet.co/?url=https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework)

### Heroku (free tier)

1. Sign up on [Heroku](https://heroku.com), if you haven't already and click on the below "Deploy to Heroku" button.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/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. 🎉

## 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](https://github.com/ctfd/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/mo heroku dyno) and not everyone has $$$ to spend on cloud, especially students (like us). So, that's where RTB-CTF-Framework (~100 KB) comes in.

## Contributing

<p>
  <a href="https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/graphs/contributors">
    <img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/abs0lut3pwn4g3/RTB-CTF-Framework?color=red&logo=github&style=for-the-badge">
  </a>
</p>

##### Join us on slack

- [#rtb-ctf-framework on slack](https://rtb-ctf-framework.slack.com)

Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md)

# License

This project is available under a dual license: a commercial one suitable for closed source projects and a A-GPL license that can be used in open source software.

Depending on your needs, you must choose one of them and follow its policies. A detail of the policies and agreements for each license type are available in the [LICENSE.COMMERCIAL](LICENSE.COMMERCIAL) and [LICENSE.AGPL](LICENSE.AGPL) files.