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

FeaturesInstallQuickstartDocsLicense


✨ 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

📦 Installation

pip install ctfbridge

🚀 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())

🧩 Supported Platforms

CTFBridge works out of the box with:

Platform Login Challenges Submit Flags Scoreboard
CTFd
rCTF
Berg
EPT
More... 🚧 🚧 🚧 🚧

📖 See docs for details.

📚 Documentation

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

🤝 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.

🛠️ Projects Using CTFBridge

These open-source tools are powered by CTFBridge:

  • ctf-dl — 🗃️ A CTF challenge bulk downloader
  • pwnv — 🧠 A CTF workspace management tool

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

📄 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.4.2.tar.gz (99.4 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.4.2-py3-none-any.whl (79.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ctfbridge-0.4.2.tar.gz
Algorithm Hash digest
SHA256 abfe7d19d72efb7a346984263b75874e4212eaf4c363b64b1c7f64135294860e
MD5 ca2a47e9a42a7c6db8b7423ba35bb983
BLAKE2b-256 9ca7b0986e3da1a6cbed248680d6fb39e3250e812587064209e66b5a61270b4f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctfbridge-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 79.1 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.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c15fbc955f6c4e22b3649daabd2a70966b6bce342013103f6ce01c63468e2ac1
MD5 3f5ea26d21a21d6a7ec1910c5caf1df5
BLAKE2b-256 44a3e1a09a69e1789445eb6cac19918e5603d473cd927e4a28964c05c89543aa

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