Skip to main content

A Python library for interacting with multiple CTF platforms.

Project description

CTFBridge

A unified Python interface for all major CTF platforms

PyPI Python Versions Docs CI License

FeaturesQuickstartInstallDocsLicense


✨ Features

  • Unified API for multiple CTF platforms
  • 🧠 Auto-detect platform type from just a URL
  • 🔐 Clean auth flow with support for credentials and API tokens
  • 🧩 Challenge enrichment — parses services and attachments from descriptions
  • 🔄 Persistent sessions — save/load session state with ease
  • 🤖 Async-first design — perfect for scripts, tools, and automation

🚀 Quickstart

import asyncio

from ctfbridge import create_client


async def main():
    # Connect and authenticate
    client = await create_client("https://demo.ctfd.io")
    await client.auth.login(username="admin", password="password")

    # Get challenges
    challenges = await client.challenges.get_all()
    for chal in challenges:
        print(f"[{chal.category}] {chal.name} ({chal.value} points)")

    # Submit a flag
    await client.challenges.submit(challenge_id=1, flag="CTF{flag}")

    # View the scoreboard
    scoreboard = await client.scoreboard.get_top(5)
    for entry in scoreboard:
        print(f"[+] {entry.rank}. {entry.name} - {entry.score} points")


if __name__ == "__main__":
    asyncio.run(main())

📦 Installation

pip install ctfbridge

🧩 Supported Platforms

CTFBridge works out of the box with:

Platform Login View Challenges Submit Flags View Scoreboard
CTFd
rCTF
GZCTF
HTB
Berg
EPT
CryptoHack
pwn.college
pwnable.tw
pwnable.kr
pwnable.xyz
More... 🚧 🚧 🚧 🚧

📖 See docs for details.

📚 Documentation

All guides and API references are available at: ctfbridge.readthedocs.io

🛠️ Projects Using CTFBridge

Project Description
ctf-dl 🗃️ A CTF challenge bulk downloader
ctf-sniper 🎯 An automated flag submission tool
pwnv 🧠 A CTF workspace management tool

Using CTFBridge in the wild? Send a PR to feature it here!

🤝 Contributing

Contributions are welcome! We appreciate any help, from bug reports and feature requests to code enhancements and documentation improvements.

Please read our Contributing Guidelines to get started.

📄 License

MIT License © 2025 bjornmorten

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctfbridge-0.8.5.tar.gz (121.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ctfbridge-0.8.5-py3-none-any.whl (119.5 kB view details)

Uploaded Python 3

File details

Details for the file ctfbridge-0.8.5.tar.gz.

File metadata

  • Download URL: ctfbridge-0.8.5.tar.gz
  • Upload date:
  • Size: 121.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ctfbridge-0.8.5.tar.gz
Algorithm Hash digest
SHA256 7d546e088affab8bac30383ee5d4fd1a17ded23c83ccfad36ee23ec2c937e973
MD5 15289a8e5c381f420583fdb7c8ae2675
BLAKE2b-256 4ab7072c718b4ea08d95f249eb6d4eee26e5bd5623baf8d953d91249f51cbc33

See more details on using hashes here.

File details

Details for the file ctfbridge-0.8.5-py3-none-any.whl.

File metadata

  • Download URL: ctfbridge-0.8.5-py3-none-any.whl
  • Upload date:
  • Size: 119.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ctfbridge-0.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 31bd02f52c45d7acdec73887ea038e3390fe220637b97a7878146bdf767c6068
MD5 0bcd386d15be4e74ec1bbcf3baa326e8
BLAKE2b-256 0dc2e83c1b825dd9713cedff0d0737d409e81ba63cd669f568155aeb53126639

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page