Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xctf-io/xctf
A simple CTF platform written in go.
https://github.com/xctf-io/xctf
ctf golang graphql typescript
Last synced: 4 days ago
JSON representation
A simple CTF platform written in go.
- Host: GitHub
- URL: https://github.com/xctf-io/xctf
- Owner: xctf-io
- License: apache-2.0
- Created: 2021-06-22T08:12:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-14T15:43:06.000Z (7 months ago)
- Last Synced: 2024-09-26T00:54:48.627Z (8 days ago)
- Topics: ctf, golang, graphql, typescript
- Language: TypeScript
- Homepage:
- Size: 13.2 MB
- Stars: 35
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xctf
A simple CTF platform written in go. An ode to the illustrious [CTFd](https://github.com/CTFd/CTFd).
We just [ran a competition](https://www.youtube.com/watch?v=2AOxuHuHS1U) 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
xctf is developed with:
- [Go](https://go.dev/): 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 xctf being extendable. Additionally, plugins for CTFg, written in any language, are made possible through projects such as [this](https://github.com/hashicorp/go-plugin).
- [React](https://react.dev/): 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](https://react.dev/learn) should teach you all you need to know.
### Running Locally
#### Server
Run this command to start the backend:
```
go run main.go
```
#### Plugins
Under development. Python is the only plugin currently. Read the [README](plugins/python/README.md) for more information.
#### Backups
To have automatic backups with sqlite, run minio:
```shell
docker run -t -p 9000:9000 -p 9090:9090 -v PATH:/mnt/data -v "$(pwd)/deploy/minio/config:/etc/config.env" -e "MINIO_CONFIG_ENV_FILE=/etc/config.env" --rm quay.io/minio/minio server --console-address ":9090"
```
Open up `http://localhost:9090`, login with `minio:minio123`, and create the bucket `xctf`.
#### Web site
Run this command to start the frontend:
```
npm run dev
```
Build the client for production:
```
npm run build
```
### Protoc Generation
```
go generate ./...
```
#### Adding a challenge
##### Written in go
1. Update [Challenge](proto/chalgen/base.proto) message to include the new challenge.
2. Run `go generate ./...`
3. Implement the challenge in the [Handle](pkg/chals/chals.go) method.
##### Written in python
1. Update [PythonChallenge](proto/plugin/python.proto) message to include the new challenge.
2. Run `go generate ./...`
3. Implement the challenge in the [Generate](plugins/python/server.py) method.