jremes-foss / BeeCTF

Laravel-Based Community CTF Platform

BeeCTF

Laravel-Based Community CTF Platform.

Introduction

BeeCTF is a CTF platform intended for small and local community groups who want to host their own CTF competitions. A small size and light weight makes BeeCTF a good platform to be hosted even in a small computer such as Raspberry Pi effectively. Built on Laravel 8, BeeCTF is easy to install and run even if your hardware is more limited.

Requirements

BeeCTF requires PHP version 7.3.0 with composer and NodeJS.

Installation

Local

Installation of BeeCTF in traditional way is easy:

git clone https://github.com/Newman101/BeeCTF
composer install
composer update
php artisan key:generate
php artisan user:create-admin

In order to build NPM dependencies for development purposes, please run:

npm install
npm run dev

Please note: pngquant dependency requires libpng-dev library, so it must be installed first in order to get the npm to build successfully. Otherwise, the result will be ELIFECYCLE error.

As BeeCTF is built on Laravel, please make sure to set the correct parameters in the .env file. To run the system after installation, you can use your own web server (such as Nginx or Apache) or use built-in server by:

php artisan serve

Docker

With Docker (currently for development purposes only, the production image is work in progress):

git clone https://github.com/Newman101/BeeCTF
composer install
composer update
docker-compose build
docker-compose up -d
docker-compose exec app php artisan migrate
docker-compose exec app php artisan user:create-admin

After creating an administrative user and database connection, the system is ready to use.

In order to debug any potential issues regarding Docker build, you have a docker-compose shell access with:

docker-compose exec app sh
docker-compose exec mysql sh
docker-compose exec webserver sh

Alternatively, you can also check which services are up:

docker-compose ps

API

There is an internal API available. This API is used for various purposes, including listing challenges, categories, and getting scoreboard on the command line.

Get Categories and Challenges

BeeCTF API allows you to fetch all categories and challenges in JSON format. Syntax as follows:

curl -X GET http://HOST/api/categories?api_token=API_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

curl -X GET http://HOST/api/challenges?api_token=API_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

Get Scoreboard

You can fetch the scoreboard via BeeCTF API. Example with cURL:

curl -X GET http://HOST/api/scoreboard?api_token=API_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

This command returns the scoreboard in JSON format.

Get Team Scoreboard

You can fetch the team scoreboard via BeeCTF API. Example with cURL:

curl -X GET http://HOST/api/teamscoreboard?api_token=API_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

This command returns the team scoreboard in JSON format.

Get Number of Solved Challenges

You can get number of solved challenges via BeeCTF API. Example with cURL:

curl -X GET http://HOST/api/numbersolved?api_token=API_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

This command returns number of challenges solved in JSON format.

Pull Requests

Feel free to send any bug fixes, new features, etc. via pull requests. Please note that BeeCTF is still heavily work in progress so there are a lot of issues to fix and all contributions are welcome. Before submitting unit tests, please make sure all unit tests pass and the code is following the standards established in contribution guide.

License

Copyright (c) <2019> Juha Remes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.