README.md
#  OWASP Juice Shop CTF Extension
[](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Flagship_Projects)
[](https://github.com/juice-shop/juice-shop-ctf/releases/latest)
[](https://twitter.com/owasp_juiceshop)
[](https://reddit.com/r/owasp_juiceshop)
[](https://github.com/juice-shop/juice-shop-ctf/actions/workflows/ci.yml)
[](https://cloud.docker.com/repository/docker/bkimminich/juice-shop-ctf/builds)
[](https://coveralls.io/github/juice-shop/juice-shop-ctf?branch=master)
[](https://codeclimate.com/github/juice-shop/juice-shop-ctf)
[](https://codeclimate.com/github/juice-shop/juice-shop-ctf/trends/technical_debt)
The Node package
[`juice-shop-ctf-cli`](https://www.npmjs.com/package/juice-shop-ctf-cli)
helps you to prepare
[Capture the Flag](https://en.wikipedia.org/wiki/Capture_the_flag#Computer_security)
events with the [OWASP Juice Shop](https://owasp-juice.shop) challenges
for different popular CTF frameworks. This interactive utility allows
you to populate a CTF game server in a matter of minutes.
## Supported CTF Frameworks
The following open source CTF frameworks are supported by
`juice-shop-ctf-cli`:
* [CTFd](https://github.com/CTFd/CTFd) (3.6 or higher)
* [RootTheBox](https://github.com/moloch--/RootTheBox) (3.3 or higher)
* [FBCTF](https://github.com/facebook/fbctf)
## Setup  [](https://www.npmjs.com/package/juice-shop-ctf-cli) [](https://www.npmjs.com/package/juice-shop-ctf-cli) 
```
npm install -g juice-shop-ctf-cli
```
## Usage
### Interactive Mode
Open a command line and run:
```
juice-shop-ctf
```
Then follow the instructions of the interactive command line tool.
### Configuration File
Instead of answering questions in the CLI you can also provide your
desired configuration in a file with the following format:
```yaml
ctfFramework: CTFd | FBCTF | RootTheBox
juiceShopUrl: https://juice-shop.herokuapp.com
ctfKey: https://raw.githubusercontent.com/bkimminich/juice-shop/master/ctf.key # can also be actual key or comma-separated list of keys (CTFd only) instead of URL
countryMapping: https://raw.githubusercontent.com/bkimminich/juice-shop/master/config/fbctf.yml # ignored for CTFd and RootTheBox
insertHints: none | free | paid # "paid" handled as "free" for CTFd
insertHintUrls: none | free | paid # optional for FBCTF; "paid" handled as "free" for CTFd
insertHintSnippets: none | free | paid # optional for FBCTF; "paid" handled as "free" for CTFd
```
You can then run the generator with:
```
juice-shop-ctf --config myconfig.yml
```
Optionally you can also choose the name of the output file:
```
juice-shop-ctf --config myconfig.yml --output challenges.out
```
You can ignore certificate warnings like this:
```
juice-shop-ctf --ignoreSslWarnings
```
### Docker Container [](https://hub.docker.com/r/bkimminich/juice-shop-ctf) [](https://hub.docker.com/r/bkimminich/juice-shop-ctf)  [](https://microbadger.com/images/bkimminich/juice-shop-ctf "Get your own image badge on microbadger.com") [](https://microbadger.com/images/bkimminich/juice-shop-ctf "Get your own version badge on microbadger.com")
Share your current directory with the `/data` volume of your
`bkimminich/juice-shop-ctf` Docker container and run the interactive
mode with:
```
docker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf
```
Alternatively you can provide a configuration file via:
```
docker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf --config myconfig.yml
```
Choosing the name of the output file is also possible:
```
docker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf --config myconfig.yml --output challenges.out
```
_On Windows `cmd.exe` you have to use `%cd%` instead of `$(pwd)` to mount your current working directory._
---
**For detailed step-by-step instructions and examples please refer to
[the _Hosting a CTF event_ chapter](https://pwning.owasp-juice.shop/part1/ctf.html)
in our (free) companion guide ebook.**
## Screenshots
## Troubleshooting [](https://gitter.im/bkimminich/juice-shop)
> If you need help with the application setup please check the
> Troubleshooting section below or post your specific problem or
> question in the
> [official Gitter Chat](https://gitter.im/bkimminich/juice-shop).
- If using Docker Toolbox on Windows make sure that you also enable port
forwarding for all required ports from Host `127.0.0.1:XXXX` to
`0.0.0.0:XXXX` for TCP in the `default` VM's network adapter in
VirtualBox. For CTFd you need to forward port `8000`.
## Contributing [](https://github.com/juice-shop/juice-shop-ctf/graphs/contributors)
Found a bug? Got an idea for enhancement? Improvement for cheating
prevention?
Feel free to
[create an issue](https://github.com/juice-shop/juice-shop-ctf/issues)
or
[post your ideas in the chat](https://gitter.im/bkimminich/juice-shop)!
Pull requests are also highly welcome - please refer to
[CONTRIBUTING.md](CONTRIBUTING.md) for details.
## Donations [](https://owasp.org/donate/?reponame=www-project-juice-shop&title=OWASP+Juice+Shop)
The OWASP Foundation gratefully accepts donations via Stripe. Projects
such as Juice Shop can then request reimbursement for expenses from the
Foundation. If you'd like to express your support of the Juice Shop
project, please make sure to tick the "Publicly list me as a supporter
of OWASP Juice Shop" checkbox on the donation form. You can find our
more about donations and how they are used here:
<https://pwning.owasp-juice.shop/part3/donations.html>
## Contributors
The OWASP Juice Shop core project team are:
- [Björn Kimminich](https://github.com/bkimminich) aka `bkimminich`
([Project Leader](https://www.owasp.org/index.php/Projects/Project_Leader_Responsibilities))
[](https://keybase.io/bkimminich)
- [Jannik Hollenbach](https://github.com/J12934) aka `J12934`
- [Timo Pagel](https://github.com/wurstbrot) aka `wurstbrot`
- [Shubham Palriwala](https://github.com/ShubhamPalriwala) aka `ShubhamPalriwala`
For a list of all contributors to the OWASP Juice Shop CTF Extension
please visit our [HALL_OF_FAME.md](HALL_OF_FAME.md).
## Licensing [](LICENSE)
This program is free software: you can redistribute it and/or modify it
under the terms of the [MIT license](LICENSE). OWASP Juice Shop CTF
Extension and any contributions are Copyright © by Bjoern Kimminich &
the OWASP Juice Shop contributors 2016-2024.
