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
GZCTF
HTB
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

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!

📄 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.6.1.tar.gz (104.3 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.6.1-py3-none-any.whl (90.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ctfbridge-0.6.1.tar.gz
Algorithm Hash digest
SHA256 d8c44d6e5a10a0253c37abe63166eeee6719a0f7fe7749cd6fa5f06bfe8e08dd
MD5 b8683fcf080b7d56f3b51495e65db979
BLAKE2b-256 970eace0d8487c0727226366d98f8d6f45b9a8d06578a0ff75cff093af94df78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctfbridge-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 90.8 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.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 330dc86fe0148d04ff78323eb1ffc2bc2a1bb38a26dadbb941237dd6a237a092
MD5 70effa75b90d29c616c301574f8089b5
BLAKE2b-256 85b7fb314101cb85547994b69017e467923a53a9437f289c37b7ad776f9510b4

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