Skip to content

README.md

Latest commit

 

History

History
84 lines (58 loc) · 2.47 KB

README.md

File metadata and controls

84 lines (58 loc) · 2.47 KB
sCCraper-IT logo

sCCraper IT

✨ Introduction

sCCraper IT is a Python-based tool designed to automate the download of all the available CTF challenges, including their metadata and attached files, via the platform APIs. It organizes the retrieved content into a structured, easy-to-navigate folder hierarchy.

🌐 Supported Platforms

This tool was designed to work with these platforms:

Note

Access to the above platforms is required. sCCraper IT uses your platform credentials to authenticate and retrieve challenge data.

🚀 Features

  • Login with API token via email/password
  • Fetches all challenges in the selected platform
  • Downloads all attached files
  • Automatically downloads hints (if user is a SUPERVISOR)
  • Saves everything in a clean folder structure

⭐ Getting Started

Clone the repository with:

git clone https://github.com/CreepyMemes/sCCraper-IT.git && cd sCCraper-IT

⚙️ Configuration

Make a new .env file in root directory, and enter your credentials there, follow the example at .env.example:

# Switch Platform
BASE_URL=https://ctf.cyberchallenge.it
# BASE_URL=https://training.olicyber.it

# Credentials
EMAIL=your@email.com
PASSWORD=your-password

✅ Usage

Install dependencies:

pip install -r requirements.txt

Run the script:

python -m src.main

📂 Output structure

After execution, you’ll find the output folder data/ generated in the root directory, with the following structure:

data/
├── challenges.json                # Metadata of all challenges
├── challenges/
│   ├── event/
│   │   ├── section/
│   │   │   ├── challenge/
│   │   │   │   ├── challenge.json # Challenge description
│   │   │   │   └── files/
│   │   │   │       ├── file       # Attached file
         ...

📌 TODO

  • CLI support (e.g. --email, --save-to)
  • Caching to avoid re-downloading
  • Logging (instead of print())