ctfs / write-ups-tools

A collection of tools used to maintain and create CTF write-up folders

Generate a CTF directory skeleton

Use genctf.py to generate a CTF write-up skeleton.

• Create an empty directory for the CTF, ending with the current year, e.g. example-ctf-2015/
• Create an empty directory in this new CTF directory for each task category, e.g. mkdir crypto web misc trivia
• Create an empty directory for each task in their respective category folder, e.g. mkdir crypto/{rsalot, rsanne}
• Download all CTF files during the CTF and save the description, points, original task name, solves and task category for each file in a file named info, e.g. crypto/rsalot/info and crypto/rsanne/info
• Generate a README.md for each info file in the CTF directory using the genctf.py tool, e.g. python genctf.py example-ctf-2015/ info 'Example CTF'
• Remove all the info files (make a backup of your CTF directory just in case) using find example-ctf-2015 -name info -delete
• Tell git to ignore all files that are bigger than 10MBytes with cd example-ctf-2015; find . -size +10M >> .gitignore
• Edit each README.md to fill in missing information (e.g. Authors, references and solves)
• Move the CTF directory to the write-ups-$YEAR repo, making sure that it does not already exist, and make a pull request

Use getscores.py to generate the scoreboard for a CTF by providing a ctftime link.

Use checkreadme.py to update the root README.md of a given CTF directory.

write-ups-tools's Issues

new tool: crawl ctftime for writeups and add to task README.md

genctf: Automatically add files >10Mb to .gitignore

new tool: check all links for 404 or 301 to remove or replace invalid links

genctf: Automatically add <> around links to make it a href

genctf: Automatically add the category based on the last directory

README checker is case sensitive and ignores lowercase filenames.

Line 22 of the script accepts only files specifically named README.md ignoring the various readme.md files in the repositories.

https://github.com/ctfs/write-ups-tools/blob/master/checkreadme.py#L22

genctf: Remove last quote line ('>')

new tool: crawl google for new writeups

genctf: Move folders with double colons in them

how specifically to write `info` files?

Sorry, having a bit of trouble using this script to generate a skeleton for the NCL ctfs, just curious on the specifics of it. Where exactly do I specify task names, files, etc? Is the script expecting a ctftime link (there isn't one for NCL) or info files at each level of a skeleton that I prefill before running genctf.py?

genctf: Delete or move files with question marks in them

new tool: check challenge references in root README.md of each ctf directory

For each ctf directory, check the root README.md for validity:

• If there exists a local writeup, aka (TODO) is replaced by a writeup, move the reference in README.md to Completed write-ups.
• Else if there exists an external writeup, aka none yet is replaced by at least one external writeup link, move the reference in README.md to External write-ups only.
• Else move the task reference to Missing write-ups

Pedantic organization

Can we make the root README the guide?

genctf: Automatically add files for each task into README.md

Add argparse instead of sys args for genctf.py

argparse is cooler (-h prints all parameters),, but did not use/need it yet.

Script does not put point values in challenge READMEs

Upon generating READMEs for a CTF skeleton, the challenge READMEs are generated leaving the Points field empty, when they could easily be pulled from the challenge's name.