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.6.tar.gz (121.5 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.6-py3-none-any.whl (119.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ctfbridge-0.8.6.tar.gz
  • Upload date:
  • Size: 121.5 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.6.tar.gz
Algorithm Hash digest
SHA256 8e86b6a521ef5220441c88d26b39c39fa826f65c555a7b0fff8f1bebf8cc29fa
MD5 b08ed61fef0040c839c883313bdc9c45
BLAKE2b-256 80c1b5c58bc9aa8baca86b7fd27a898e46c8ca40c727275da494d4aa4208e8e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctfbridge-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 119.4 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a53ee030432d0241d846fdd486a6f6bca9e758e6899e6cadec34fc18532b220f
MD5 c83bec9a629f1a447e83bcd487efb524
BLAKE2b-256 49b7fb008ffa739cbd61986acc4aac54dad36c51eb9a54ed7082cfddb705bb94

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