{"id":19253034,"url":"https://github.com/juice-shop/juice-shop-ctf","last_synced_at":"2025-04-08T09:07:20.624Z","repository":{"id":40295799,"uuid":"74905947","full_name":"juice-shop/juice-shop-ctf","owner":"juice-shop","description":"Tool to export Juice Shop challenges and hints in data format compatible with CTFd, RootTheBox or FBCTF","archived":false,"fork":false,"pushed_at":"2024-03-29T22:46:47.000Z","size":3811,"stargazers_count":395,"open_issues_count":0,"forks_count":109,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-05-21T13:52:34.130Z","etag":null,"topics":["24pullrequests","application-security","capture-the-flag","ctf","ctf-frameworks","ctfd","ctfd-database","ctfd-setup","facebook-ctf","fbctf","hacking","hacktoberfest","owasp","owasp-juice-shop","pentesting","rootthebox","rtb"],"latest_commit_sha":null,"homepage":"http://owasp-juice.shop","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juice-shop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"custom":"https://sponsor.owasp-juice.shop"}},"created_at":"2016-11-27T18:22:36.000Z","updated_at":"2024-05-21T13:52:34.131Z","dependencies_parsed_at":"2022-07-20T07:16:57.477Z","dependency_job_id":"ff5bd731-4d38-42d8-82fb-36b7af227f6e","html_url":"https://github.com/juice-shop/juice-shop-ctf","commit_stats":{"total_commits":554,"total_committers":14,"mean_commits":39.57142857142857,"dds":"0.20036101083032487","last_synced_commit":"3b18bcd11b6df08c26c4c423b9d01e26ccc8dad5"},"previous_names":["bkimminich/juice-shop-ctf"],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juice-shop%2Fjuice-shop-ctf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juice-shop%2Fjuice-shop-ctf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juice-shop%2Fjuice-shop-ctf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juice-shop%2Fjuice-shop-ctf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juice-shop","download_url":"https://codeload.github.com/juice-shop/juice-shop-ctf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809962,"owners_count":20999816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["24pullrequests","application-security","capture-the-flag","ctf","ctf-frameworks","ctfd","ctfd-database","ctfd-setup","facebook-ctf","fbctf","hacking","hacktoberfest","owasp","owasp-juice-shop","pentesting","rootthebox","rtb"],"created_at":"2024-11-09T18:29:16.351Z","updated_at":"2025-04-08T09:07:20.595Z","avatar_url":"https://github.com/juice-shop.png","language":"JavaScript","funding_links":["https://sponsor.owasp-juice.shop"],"categories":["Online Platforms"],"sub_categories":[],"readme":"# ![Juice Shop CTF Logo](https://raw.githubusercontent.com/juice-shop/juice-shop-ctf/master/images/JuiceShopCTF_Logo_100px.png) OWASP Juice Shop CTF Extension\n\n[![OWASP Flagship](https://img.shields.io/badge/owasp-flagship%20project-48A646.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Flagship_Projects)  \n[![GitHub release](https://img.shields.io/github/release/juice-shop/juice-shop-ctf.svg)](https://github.com/juice-shop/juice-shop-ctf/releases/latest)  \n[![Twitter Follow](https://img.shields.io/twitter/follow/owasp_juiceshop.svg?style=social\u0026label=Follow)](https://twitter.com/owasp_juiceshop)  \n[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/owasp_juiceshop?style=social)](https://reddit.com/r/owasp_juiceshop)\n\n[![CI Pipeline](https://github.com/juice-shop/juice-shop-ctf/actions/workflows/ci.yml/badge.svg)](https://github.com/juice-shop/juice-shop-ctf/actions/workflows/ci.yml)\n[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/bkimminich/juice-shop-ctf.svg)](https://cloud.docker.com/repository/docker/bkimminich/juice-shop-ctf/builds)\n[![Coverage Status](https://coveralls.io/repos/github/juice-shop/juice-shop-ctf/badge.svg?branch=master)](https://coveralls.io/github/juice-shop/juice-shop-ctf?branch=master)\n[![Code Climate](https://codeclimate.com/github/juice-shop/juice-shop-ctf/badges/gpa.svg)](https://codeclimate.com/github/juice-shop/juice-shop-ctf)\n[![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/juice-shop/juice-shop-ctf)](https://codeclimate.com/github/juice-shop/juice-shop-ctf/trends/technical_debt)  \n![GitHub stars](https://img.shields.io/github/stars/juice-shop/juice-shop-ctf.svg?label=GitHub%20%E2%98%85\u0026style=flat)\n\nThe Node package\n[`juice-shop-ctf-cli`](https://www.npmjs.com/package/juice-shop-ctf-cli)\nhelps you to prepare\n[Capture the Flag](https://en.wikipedia.org/wiki/Capture_the_flag#Computer_security)\nevents with the [OWASP Juice Shop](https://owasp-juice.shop) challenges\nfor different popular CTF frameworks. This interactive utility allows\nyou to populate a CTF game server in a matter of minutes.\n\n![Screenshot of juice-shop-ctf-cli in Powershell](images/juice-shop-ctf-cli.png)\n\n## Supported CTF Frameworks\n\nThe following open source CTF frameworks are supported by\n`juice-shop-ctf-cli`:\n\n* [CTFd](https://github.com/CTFd/CTFd) (3.6 or higher)\n* [RootTheBox](https://github.com/moloch--/RootTheBox) (3.3 or higher)\n* [FBCTF](https://github.com/facebook/fbctf)\n\n## Setup ![node](https://img.shields.io/node/v/juice-shop-ctf-cli.svg) [![npm](https://img.shields.io/npm/dm/juice-shop-ctf-cli.svg)](https://www.npmjs.com/package/juice-shop-ctf-cli) [![npm](https://img.shields.io/npm/dt/juice-shop-ctf-cli.svg)](https://www.npmjs.com/package/juice-shop-ctf-cli) ![npm bundle size](https://img.shields.io/bundlephobia/min/juice-shop-ctf-cli.svg)\n\n```\nnpm install -g juice-shop-ctf-cli\n```\n\n## Usage\n\n### Interactive Mode\n\nOpen a command line and run:\n\n```\njuice-shop-ctf\n```\n\nThen follow the instructions of the interactive command line tool.\n\n### Configuration File\n\nInstead of answering questions in the CLI you can also provide your\ndesired configuration in a file with the following format:\n\n```yaml\nctfFramework: CTFd | FBCTF | RootTheBox\njuiceShopUrl: https://juice-shop.herokuapp.com\nctfKey: 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\ncountryMapping: https://raw.githubusercontent.com/bkimminich/juice-shop/master/config/fbctf.yml # ignored for CTFd and RootTheBox\ninsertHints: none | free | paid # \"paid\" handled as \"free\" for CTFd\ninsertHintUrls: none | free | paid # optional for FBCTF; \"paid\" handled as \"free\" for CTFd\ninsertHintSnippets: none | free | paid # optional for FBCTF; \"paid\" handled as \"free\" for CTFd\n```\n\nYou can then run the generator with:\n\n```\njuice-shop-ctf --config myconfig.yml\n```\n\nOptionally you can also choose the name of the output file:\n\n```\njuice-shop-ctf --config myconfig.yml --output challenges.out\n```\n\nYou can ignore certificate warnings like this:\n\n```\njuice-shop-ctf --ignoreSslWarnings\n```\n\n### Docker Container [![Docker Automated build](https://img.shields.io/docker/automated/bkimminich/juice-shop-ctf.svg)](https://hub.docker.com/r/bkimminich/juice-shop-ctf) [![Docker Pulls](https://img.shields.io/docker/pulls/bkimminich/juice-shop-ctf.svg)](https://hub.docker.com/r/bkimminich/juice-shop-ctf) ![Docker Stars](https://img.shields.io/docker/stars/bkimminich/juice-shop-ctf.svg) [![](https://images.microbadger.com/badges/image/bkimminich/juice-shop-ctf.svg)](https://microbadger.com/images/bkimminich/juice-shop-ctf \"Get your own image badge on microbadger.com\") [![](https://images.microbadger.com/badges/version/bkimminich/juice-shop-ctf.svg)](https://microbadger.com/images/bkimminich/juice-shop-ctf \"Get your own version badge on microbadger.com\")\n\nShare your current directory with the `/data` volume of your\n`bkimminich/juice-shop-ctf` Docker container and run the interactive\nmode with:\n\n```\ndocker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf\n```\n\nAlternatively you can provide a configuration file via:\n\n```\ndocker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf --config myconfig.yml\n```\n\nChoosing the name of the output file is also possible:\n\n```\ndocker run -ti --rm -v $(pwd):/data bkimminich/juice-shop-ctf --config myconfig.yml --output challenges.out\n```\n\n_On Windows `cmd.exe` you have to use `%cd%` instead of `$(pwd)` to mount your current working directory._\n\n---\n\n**For detailed step-by-step instructions and examples please refer to\n[the _Hosting a CTF event_ chapter](https://pwning.owasp-juice.shop/companion-guide/latest/part1/ctf.html)\nin our (free) companion guide ebook.**\n\n## Screenshots\n\n![CTFd challenge overview](https://pwning.owasp-juice.shop/companion-guide/latest/_images/part1/ctfd_1.png)\n\n![FBCTF world map](https://pwning.owasp-juice.shop/companion-guide/latest/_images/part1/fbctf_1.png)\n\n![RTB challenge boxes](https://pwning.owasp-juice.shop/companion-guide/latest/_images/part1/rtb_1.png)\n\n## Troubleshooting [![Gitter](http://img.shields.io/badge/gitter-join%20chat-1dce73.svg)](https://gitter.im/bkimminich/juice-shop)\n\n\u003e If you need help with the application setup please check the\n\u003e Troubleshooting section below or post your specific problem or\n\u003e question in the\n\u003e [official Gitter Chat](https://gitter.im/bkimminich/juice-shop).\n\n- If using Docker Toolbox on Windows make sure that you also enable port\n  forwarding for all required ports from Host `127.0.0.1:XXXX` to\n  `0.0.0.0:XXXX` for TCP in the `default` VM's network adapter in\n  VirtualBox. For CTFd you need to forward port `8000`.\n\n## Contributing [![GitHub contributors](https://img.shields.io/github/contributors/juice-shop/juice-shop-ctf.svg)](https://github.com/juice-shop/juice-shop-ctf/graphs/contributors)\n\nFound a bug? Got an idea for enhancement? Improvement for cheating\nprevention?\n\nFeel free to\n[create an issue](https://github.com/juice-shop/juice-shop-ctf/issues)\nor\n[post your ideas in the chat](https://gitter.im/bkimminich/juice-shop)!\nPull requests are also highly welcome - please refer to\n[CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n## Donations [![](https://img.shields.io/badge/support-owasp%20juice%20shop-blue)](https://owasp.org/donate/?reponame=www-project-juice-shop\u0026title=OWASP+Juice+Shop)\n\nThe OWASP Foundation gratefully accepts donations via Stripe. Projects\nsuch as Juice Shop can then request reimbursement for expenses from the\nFoundation. If you'd like to express your support of the Juice Shop\nproject, please make sure to tick the \"Publicly list me as a supporter\nof OWASP Juice Shop\" checkbox on the donation form. You can find our\nmore about donations and how they are used here:\n\n\u003chttps://pwning.owasp-juice.shop/companion-guide/latest/part3/donations.html\u003e\n\n## Contributors\n\nThe OWASP Juice Shop Project Leaders are:\n\n- [Björn Kimminich](https://github.com/bkimminich) aka `bkimminich` [![Keybase PGP](https://img.shields.io/keybase/pgp/bkimminich)](https://keybase.io/bkimminich)\n- [Jannik Hollenbach](https://github.com/J12934) aka `J12934`\n\nFor a list of all contributors to the OWASP Juice Shop CTF Extension\nplease visit our [HALL_OF_FAME.md](HALL_OF_FAME.md).\n\n## Licensing [![license](https://img.shields.io/github/license/juice-shop/juice-shop-ctf.svg)](LICENSE)\n\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the [MIT license](LICENSE). OWASP Juice Shop CTF\nExtension and any contributions are Copyright © by Bjoern Kimminich \u0026\nthe OWASP Juice Shop contributors 2016-2025.\n\n![Juice Shop CTF Logo](https://raw.githubusercontent.com/juice-shop/juice-shop-ctf/develop/images/JuiceShopCTF_Logo_400px.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuice-shop%2Fjuice-shop-ctf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuice-shop%2Fjuice-shop-ctf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuice-shop%2Fjuice-shop-ctf/lists"}