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
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.1.tar.gz (98.0 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.1-py3-none-any.whl (75.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ctfbridge-0.4.1.tar.gz
Algorithm Hash digest
SHA256 9ed43a61edc6f4ac07bcfbd9cea5b4c46c6583cbecc760c32edd4d13b9a3ac33
MD5 b867eca7eac7009a349b86945d268c6e
BLAKE2b-256 df4c33bea3f9913f0b91a0ed02aafcfc26c2f019af7c0c8cc8a7272440e98849

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctfbridge-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 75.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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d32d4fcfbcfad590454b347c446238c2e63ed7003fd5dba340962a398113096d
MD5 b2cf36ef590525d30de9d448be2d6f1c
BLAKE2b-256 d37fc50ff86c33e1320d5f7f77407d200d3c14f0fe7abb9b88a7d0be4c31f7a3

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