Package: reteps-ctfcli
ctfclictfcli is a tool to manage Capture The Flag events and challenges.ctfcliprovides challenge specifications and templates to make it easier to generate challenges of different categories. It also provides an integration with theCTFdREST API to allow for command line uploading of challenges and integration with CI/CD build systems.ctfclifeatures tab completion, a REPL interface (thanks toPython-Fire) and plugin support for custom commands.WIP: ctfcli is an alpha project and changes will happen. Be sure to pin versions and read the CHANGELOG when updating.Installation and Usagectfcli can be installed withpip install ctfcli1. Create an Eventctfcli turns the current folder into a CTF event git repo. It asks for the base url of the CTFd instance you're working with and an access token.❯ ctf init
Please enter CTFd instance URL: https://demo.ctfd.io
Please enter CTFd Admin Access Token: d41d8cd98f00b204e9800998ecf8427e
Do you want to continue with https://demo.ctfd.io and d41d8cd98f00b204e9800998ecf8427e [y/N]: y
Initialized empty Git repository in /Users/user/Downloads/event/.git/This will create the.ctffolder with theconfigfile that will specify the URL, access token, and keep a record of all the challenges dedicated for this event.2. Add challengesEvents are made up of challenges. Challenges can be made from a subdirectory or pulled from another repository. Remote challenges are pulled into the event repo and a reference is kept in the.ctf/configfile.❯ ctf challenge add [REPO | FOLDER]❯ ctf challenge add crypto/stuff❯ ctf challenge add https://github.com/challenge.git
challenge
Cloning into 'challenge'...
remote: Enumerating objects: 624, done.
remote: Counting objects: 100% (624/624), done.
remote: Compressing objects: 100% (540/540), done.
remote: Total 624 (delta 109), reused 335 (delta 45), pack-reused 0
Receiving objects: 100% (624/624), 6.49 MiB | 21.31 MiB/s, done.
Resolving deltas: 100% (109/109), done.3. Install challengesInstalling a challenge will automatically create the challenge in your CTFd instance using the API.❯ ctf challenge install [challenge.yml | DIRECTORY]❯ ctf challenge install buffer_overflow
Found buffer_overflow/challenge.yml
Loaded buffer_overflow
Installing buffer_overflow
Success!4. Update challengesSyncing a challenge will automatically update the challenge in your CTFd instance using the API. Any changes made in thechallenge.ymlfile will be reflected in your instance.❯ ctf challenge sync [challenge.yml | DIRECTORY]❯ ctf challenge sync buffer_overflow
Found buffer_overflow/challenge.yml
Loaded buffer_overflow
Syncing buffer_overflow
Success!The additional flag,--ctfd-name [NAME]can be passed to optionally sync to a challenge with a different-name in CTFd.5. Verify & pull challengesIf, at any point, changes may have been made to a challenge through the CTFd UI by an admin. To verify that your challenge.yml file matches remote contents, you can use:❯ ctf challenge verify [challenge.yml | DIRECTORY] [--verify-files] [--verify-defaults]If the--verify-filesflag is set, challenge files will be downloaded and the binary files will be compared.If the--verify-defaultsflag is set, challenge files will be verified to make sure they include default optional keys present on CTFd.
If you want to pull down the latest version of the challenge, and its challenge files, you can use:❯ ctf challenge verify [challenge.yml | DIRECTORY] [--update_files] [--create-files] [--create_defaults]If the--update_filesflag is set, the latest version of every file will be redownloaded from CTFd.If the--create-filesflag is set, any new files added to through the CTFd UI will be downloaded to the same directory as thechallenge.ymlfile.If the--create-defaultsflag is set, any optional default values will be added to thechallenge.yml.This is a destructive action! It will overwrite the local version ofchallenge.ymlwith the version on CTFd!Challenge Templatesctfclicontains pre-made challenge templates to make it faster to create CTF challenges with safe defaults.ctf challenge new
                ├── binary
                ├── crypto
                ├── programming
                └── web❯ ctf challenge new binary
/Users/user/.virtualenvs/ctfcli/lib/python3.7/site-packages/ctfcli-0.0.1-py3.7.egg/ctfcli/templates/binary/default
name [Hello]: buffer_overflow

❯ ls -1 buffer_overflow
Makefile
README.md
WRITEUP.md
challenge.yml
dist/
src/Contributions welcome on improving the challenge templates to make CTF challenges better for everyone!Challenge Specificationctfcliprovides achallenge specification(challenge.yml) that outlines the major details of a challenge.Every challenge generated by or processed byctfclishould have achallenge.ymlfile.The specification format has already been tested and used with CTFd in production events but comments, suggestions, and PRs are welcome on the format ofchallenge.yml.Pluginsctfcliplugins are essentially additions to to the command line interface via dynamic class modifications. See theplugin documentation pagefor a simple example.ctfcliis an alpha project! The plugin interface is likely to change!