[![csivit][csivitu-shield]][csivitu-url]

![All Contributors](#contributors-)

[![Issues][issues-shield]][issues-url]

ctfup

A CLI tool to deploy CTF challenges to a k8 cluster for csictf.

Explore the docs »

View Demo
·
Report Bug
·
Request Feature

- About the Project
- Built With
- Getting Started
- Prerequisites
- Installation
- Usage
- Roadmap
- Contributing
- License
- Contributors

About The Project

ctfup is an npm package developed to streamline the deployment of CTF challenges to a kubernetes cluster.

$3

- NodeJS
- Typescript
- Google Kubernetes

Getting Started

To get a local copy up and running follow these simple steps.

$3

This package is intended to be used in your CI script, or with the appropriate Google Cloud SDK.

- npm

``sh npm install npm@latest -g`

- A Google Cloud account with the Kubernetes Engine enabled. - A Google Cloud Service account.

`$3`

1. Clone the repo

`sh git clone https://github.com/csivitu/ctfup.git`

2. Install NPM packages

`sh npm install`

`Usage`

1. Assuming you have a repository for challenges, kindly structure it as follows:

`bash ├── pwn │ ├── pwn-challenge-1 │ │ ├── * │ │ ├──challenge.yml │ │ ├──Dockerfile │ │ └──.dockerignore │ │ │ ├── pwn-challenge-2 │ │ ├── * │ │ ├──challenge.yml │ │ ├──Dockerfile │ │ └──.dockerignore │ │ │ └── pwn-challenge-3 │ ├── crypto ├── forensics ├── linux ├── reversing ├── miscellaneous ├── osint ├── pwn ├── web └── ctfup.yml`

The directories pwn , crypto etc. each have sub directories with each sub directory having a challenge.yml, a Dockerfile and corresponding .dockerignore.

2. The root directory of your repository must have a config file ctfup.yml as per the format.

`yaml categories: - "crypto" - "forensics" - "linux" - "reversing" - "miscellaneous" - "osint" - "pwn" - "web" registry: "gcr.io/-"`

3. The format of challenge.yml is as follows:

`yaml

`This file represents the base specification of your challenge. It is used by`


other tools to install and deploy your challenge.
Required sections

name: "challenge name"
author: "author"
Select a category from:

- Pwn

- Web

- OSINT

- Linux

- Crypto

- Forensics

- Reversing

- Miscellaneous

category: category
This is the challenge description. Make sure you include the

necessary URLs / netcat strings here.

description: This is a sample description
This is the number of points awarded for the challenge.

value: 500
type: dynamic
Number of solves it takes to reach the minimum value.

decay: 450
Minimum value.

minimum: 100
Flags specify answers that your challenge use. You should generally provide

at least one.

Can be removed if unused

Accepts strings or dictionaries

flags:
  - csictf{this_is_a_sample_flag}
  - { type: "static", content: "csictf{another_flag}", data: "asdfasdfsdf" }
Tags are used to classify your challenge with topics. You should provide at

least one.

Can be removed if unused

Accepts strings

tags:
  - web
  - sandbox
  - js
Provide paths to files from the same directory that this file is in

Accepts strings

files:
  - dist/source.py
Hints are used to give players a way to buy or have suggestions. They are not

required but can be nice.

Can be removed if unused

Accepts dictionaries or strings

hints:
  - { content: "This hint costs points", cost: 10 }
  - This hint is free
The state of the challenge.

May be "visible" or "hidden".

It is "visible" by default.

state: hidden
Specifies what version of the challenge specification was used.

Subject to change until ctfcli v1.0.0

version: "0.1"
The ports to expose. The target port will be used to access the deployed container.

expose:
- containerPort: 9999
  targetPort: 30231

4. The directory containing the challenge.ymlfile must _also_ contain a Dockerfile which will be used by GKE.

5. Setup your preferred CI for your project. In this case, we will use a Github Action.

`yaml - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: "12" - run: npm install -g ctfup`

6. Add the required secrets and in your yaml config file, set up the gcloud environment with

`yaml uses: GoogleCloudPlatform/github-actions/setup-gcloud@master with: version: '290.0.1' service_account_key: ${{ secrets.GKE_SA_KEY }} project_id: ${{ secrets.GKE_PROJECT }}`

Note: use the latest version of the Github Action.

7. Additional setup

`yaml

`Configure Docker to use the gcloud command-line tool as a credential`


helper for authentication

- run: |-
    gcloud --quiet auth configure-docker
Get the GKE credentials so we can deploy to the cluster

- run: |-
    gcloud container clusters get-credentials "${{ secrets.GKE_CLUSTER_NAME }}" --zone "${{ secrets.GKE_CLUSTER_ZONE }}"




8. Deploy

`yaml - name: Deploy run: ctfup -c ctfup.yml .`

`Roadmap`

See the open issues for a list of proposed features (and known issues).

`Contributing`

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project 2. Create your Feature Branch (git checkout -b feature/AmazingFeature) 3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature') 4. Push to the Branch (git push origin feature/AmazingFeature) 5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project :smile:.

`License`

Distributed under the MIT License. See LICENSE` for more information.

[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue
[csivitu-url]: https://csivit.com
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square
[issues-url]: https://github.com/csivitu/ctfup/issues

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Rishit Bansal}
💻 🚇

_{Rohan Mukherjee}
💻 🚇

_{theProgrammerDavid}
📖

This project follows the all-contributors specification. Contributions of any kind welcome!

[![csivit][csivitu-shield]][csivitu-url]

![All Contributors](#contributors-)

[![Issues][issues-shield]][issues-url]

ctfup

A CLI tool to deploy CTF challenges to a k8 cluster for csictf.

Explore the docs »

View Demo
·
Report Bug
·
Request Feature

- About the Project
- Built With
- Getting Started
- Prerequisites
- Installation
- Usage
- Roadmap
- Contributing
- License
- Contributors

About The Project

ctfup is an npm package developed to streamline the deployment of CTF challenges to a kubernetes cluster.

$3

- NodeJS
- Typescript
- Google Kubernetes

Getting Started

To get a local copy up and running follow these simple steps.

$3

This package is intended to be used in your CI script, or with the appropriate Google Cloud SDK.

- npm

``sh npm install npm@latest -g`

- A Google Cloud account with the Kubernetes Engine enabled. - A Google Cloud Service account.

`$3`

1. Clone the repo

`sh git clone https://github.com/csivitu/ctfup.git`

2. Install NPM packages

`sh npm install`

`Usage`

1. Assuming you have a repository for challenges, kindly structure it as follows:

The directories pwn , crypto etc. each have sub directories with each sub directory having a challenge.yml, a Dockerfile and corresponding .dockerignore.

2. The root directory of your repository must have a config file ctfup.yml as per the format.

`yaml categories: - "crypto" - "forensics" - "linux" - "reversing" - "miscellaneous" - "osint" - "pwn" - "web" registry: "gcr.io/-"`

3. The format of challenge.yml is as follows:

`yaml

`This file represents the base specification of your challenge. It is used by`


other tools to install and deploy your challenge.
Required sections

name: "challenge name"
author: "author"
Select a category from:

- Pwn

- Web

- OSINT

- Linux

- Crypto

- Forensics

- Reversing

- Miscellaneous

category: category
This is the challenge description. Make sure you include the

necessary URLs / netcat strings here.

description: This is a sample description
This is the number of points awarded for the challenge.

value: 500
type: dynamic
Number of solves it takes to reach the minimum value.

decay: 450
Minimum value.

minimum: 100
Flags specify answers that your challenge use. You should generally provide

at least one.

Can be removed if unused

Accepts strings or dictionaries

flags:
  - csictf{this_is_a_sample_flag}
  - { type: "static", content: "csictf{another_flag}", data: "asdfasdfsdf" }
Tags are used to classify your challenge with topics. You should provide at

least one.

Can be removed if unused

Accepts strings

tags:
  - web
  - sandbox
  - js
Provide paths to files from the same directory that this file is in

Accepts strings

files:
  - dist/source.py
Hints are used to give players a way to buy or have suggestions. They are not

required but can be nice.

Can be removed if unused

Accepts dictionaries or strings

hints:
  - { content: "This hint costs points", cost: 10 }
  - This hint is free
The state of the challenge.

May be "visible" or "hidden".

It is "visible" by default.

state: hidden
Specifies what version of the challenge specification was used.

Subject to change until ctfcli v1.0.0

version: "0.1"
The ports to expose. The target port will be used to access the deployed container.

expose:
- containerPort: 9999
  targetPort: 30231

4. The directory containing the challenge.ymlfile must _also_ contain a Dockerfile which will be used by GKE.

5. Setup your preferred CI for your project. In this case, we will use a Github Action.

`yaml - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: "12" - run: npm install -g ctfup`

6. Add the required secrets and in your yaml config file, set up the gcloud environment with

`yaml uses: GoogleCloudPlatform/github-actions/setup-gcloud@master with: version: '290.0.1' service_account_key: ${{ secrets.GKE_SA_KEY }} project_id: ${{ secrets.GKE_PROJECT }}`

Note: use the latest version of the Github Action.

7. Additional setup

`yaml

`Configure Docker to use the gcloud command-line tool as a credential`


helper for authentication

- run: |-
    gcloud --quiet auth configure-docker
Get the GKE credentials so we can deploy to the cluster

- run: |-
    gcloud container clusters get-credentials "${{ secrets.GKE_CLUSTER_NAME }}" --zone "${{ secrets.GKE_CLUSTER_ZONE }}"




8. Deploy

`yaml - name: Deploy run: ctfup -c ctfup.yml .`

`Roadmap`

See the open issues for a list of proposed features (and known issues).

`Contributing`

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project :smile:.

`License`

Distributed under the MIT License. See LICENSE` for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Rishit Bansal}
💻 🚇

_{Rohan Mukherjee}
💻 🚇

_{theProgrammerDavid}
📖

This project follows the all-contributors specification. Contributions of any kind welcome!

ctfup

ctfup

Table of Contents

About The Project

$3

Getting Started

$3

$3

Usage

This file represents the base specification of your challenge. It is used by

other tools to install and deploy your challenge.

Required sections

Select a category from:

- Pwn

- Web

- OSINT

- Linux

- Crypto

- Forensics

- Reversing

- Miscellaneous

This is the challenge description. Make sure you include the

necessary URLs / netcat strings here.

This is the number of points awarded for the challenge.

Number of solves it takes to reach the minimum value.

Minimum value.

Flags specify answers that your challenge use. You should generally provide

at least one.

Can be removed if unused

Accepts strings or dictionaries

Tags are used to classify your challenge with topics. You should provide at

least one.

Can be removed if unused

Accepts strings

Provide paths to files from the same directory that this file is in

Accepts strings

Hints are used to give players a way to buy or have suggestions. They are not

required but can be nice.

Can be removed if unused

Accepts dictionaries or strings

The state of the challenge.

May be "visible" or "hidden".

It is "visible" by default.

Specifies what version of the challenge specification was used.

Subject to change until ctfcli v1.0.0

The ports to expose. The target port will be used to access the deployed container.

Configure Docker to use the gcloud command-line tool as a credential

helper for authentication

Get the GKE credentials so we can deploy to the cluster

Roadmap

Contributing

License

Contributors ✨

ctfup

ctfup

Table of Contents

About The Project

$3

Getting Started

$3

$3

Usage

This file represents the base specification of your challenge. It is used by

other tools to install and deploy your challenge.

Required sections

Select a category from:

- Pwn

- Web

- OSINT

- Linux

- Crypto

- Forensics

- Reversing

- Miscellaneous

This is the challenge description. Make sure you include the

necessary URLs / netcat strings here.

This is the number of points awarded for the challenge.

Number of solves it takes to reach the minimum value.

Minimum value.

Flags specify answers that your challenge use. You should generally provide

`$3`

`Usage`

`This file represents the base specification of your challenge. It is used by`

`Configure Docker to use the gcloud command-line tool as a credential`

`Roadmap`

`Contributing`

`License`

`$3`

`Usage`

`This file represents the base specification of your challenge. It is used by`

`Configure Docker to use the gcloud command-line tool as a credential`

`Roadmap`

`Contributing`

`License`