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 — categories, services, attachments
  • 🔄 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 Flags Scoreboard
CTFd
rCTF
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.0.post1.tar.gz (100.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.0.post1-py3-none-any.whl (83.6 kB view details)

Uploaded Python 3

File details

Details for the file ctfbridge-0.0.post1.tar.gz.

File metadata

  • Download URL: ctfbridge-0.0.post1.tar.gz
  • Upload date:
  • Size: 100.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for ctfbridge-0.0.post1.tar.gz
Algorithm Hash digest
SHA256 81f6f1e1adda4f05754c5bfbd8c2724ddd38655f2155e25aabedee0cb43032f4
MD5 c854e3d33072df702a1595ade3935d4f
BLAKE2b-256 b3932b56f8172c82f08238ef1a9df9aff7199bd3a075d949185aa60ed1586a7f

See more details on using hashes here.

File details

Details for the file ctfbridge-0.0.post1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ctfbridge-0.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 6bd07364b2c5f116762c8234a3dfbdfbf5098c27e037d10fd496eb7dd2b119db
MD5 acf6919a6ddde648ca8d7505ee2505d9
BLAKE2b-256 3489e265a969b434ed80147b6df7e22d57dcfa65e455312e6ee7fd5c47d35c6d

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