init

dimasma0305 · Aug 9, 2023 · 86defe4 · 86defe4
1 parent 46030a8
commit 86defe4
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,46 @@
+# CTF-XSS-BOT
+
+![Alt text](./assets/bothome.png)
+
+CTF-XSS-BOT is a flexible template designed for crafting Cross-Site Scripting
+(XSS) challenges in Capture The Flag (CTF) competitions. This project provides a
+foundation for effortlessly setting up an environment to host XSS challenges,
+while utilizing Puppeteer to simulate web browser behavior.
+
+## Features
+
+- **Customize APP Name:** Easily set a custom application name to match your challenge theme.
+- **White List URL By Regex:** Define a regex pattern to whitelist specific URLs for challenge interaction.
+- **Rate Limiting:** Prevent abuse with built-in rate limiting to control participant interactions.
+
+## Usage
+
+1. Clone this repository:
+   ```sh
+   git clone https://github.com/dimasma0305/CTF-XSS-BOT.git
+   cd CTF-XSS-BOT
+   ```
+
+2. Customize the source code of your challenge at `./src/*`.
+
+3. Configure the parameters in `docker-compose.yaml`:
+   ```yaml
+   ...snip...
+    environment:
+        APPNAME: YourAppName
+        APPURL: YourAppURL
+        APPURLREGEX: YourAppURLRegex
+        APPFLAG: dev{flag}
+        APPLIMIT: 2
+        APPLIMITTIME: 60
+    ...snip...
+   ```
+
+4. Deploy the template using Docker Compose:
+   ```sh
+   docker-compose up -d
+   ```
+   ![Deploy with Docker](./assets/deploy-wdocker.png)
+
+5. Your `./src` will be hosted at http://localhost/, and the bot can be accessed
+   at http://localhost/report. Customize your XSS challenges and empower participants to master web security.
diff --git a/assets/bothome.png b/assets/bothome.png
diff --git a/assets/deploy-wdocker.png b/assets/deploy-wdocker.png
diff --git a/src/index.html b/src/index.html
@@ -10,6 +10,7 @@
 </head>
 
 <body data-bs-theme="dark">
+
 </body>
 
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ @@
     </head>
     <body data-bs-theme="dark">
     </body>
     <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"
@@ Expand Down @@