Skip to main content

Tool for CI/CD pipelines to deploy CTFs

Project description

ctf-cicd

Program to deploy automatically CTF challenges in CTFD. This tool tries to answer the limitations of ctfcli, when you use it for continuos deployment. The settings are passed to the program using environment variables and there is no need to have config files in the repository.

The majority of the features are implemented using ctfcli and also inpired by the blogpost from Rohan Mukherjee.

Running and configure this tool

ctf-cicd deploys all challenges (challenge.yml) that are detected in the current directory or any of its subfolders. To define challenges, they must respect the ctfcli specification.

Installation

$ pip3 install .

Running

$ ctfcicd

Settings

CTFD_TOKEN: CTFd Admin Access Token (ex. d41d8cd98f00b204e9800998ecf8427e)

CTFD_URL: CTFd instance URL (ex. https://demo.ctfd.io)

DEPLOY_HOST: URI of the method that you want to use to deploy your dockerized challenge (More info).

DEPLOY_NETWORK: Optional variable to specify to which network you want the container attached.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctfcicd-1.1.2.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

ctfcicd-1.1.2-py3-none-any.whl (10.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page