ctfg_go

README

CTFg

A simple CTF platform written in go. An ode to the illustrious CTFd.

We just ran a competition for 200 high schoolers in person using this framework.

Have ideas about what should go in here? Come talk to us on !

Currently in alpha.

Goals

• Simple: Capture only the basics of what a CTF competition needs in a single binary.
• Extendable: A well documented API to allow for creativity and variety of competitions.

Development

Tech Stack

CTFg is developed with:

• Go: This is used for the server.
  • Reasoning: This was chosen to make development and deployment easy and consistent. While python or javascript would be more approachable languages to more people, Go's types and tools are more conducive for CTFg being extendable. Additionally, plugins for CTFg, written in any language, are made possible through projects such as this.
• React: This is used for client.
  • Reasoning: This was chosen because using react has the best libraries and support by the community. While we prefer other frameworks, React's ecosystem is simply unmatched. If you are not familiar with React, the tutorial should teach you all you need to know.

Running Locally

Live reloads

To enable live reloads, you will need to install air

curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

Then run:

air

This will reload the website and server on any changes.

Web site

Build the client for development:

cd client
yarn dev

Build the client for production:

cd client
yarn build

Server

go run cmd/main.go

Protoc Generation

Install the necessary tools:

go install github.com/twitchtv/twirp/protoc-gen-twirp
go install google.golang.org/protobuf/cmd/protoc-gen-go
npm install -g @protobuf-ts/plugin twirp-ts

Then run:

protoc --go_out=. --twirp_out=. --ts_out=client/src --twirp_ts_out=client/src proto/ctfg.proto
mv client/src/proto/ctfg.ts client/src/rpc/ctfg.ts
mv client/src/proto/ctfg.twirp.ts client/src/rpc/ctfg.twirp.ts
rm -rf client/src/proto