❓ Frequently Asked Questions (FAQ)¶

This page provides answers to common questions about CTFBridge. If you don't find your answer here, feel free to open an issue on GitHub.

Q1: What is CTFBridge?¶

CTFBridge is a Python library designed to provide a unified, consistent interface for interacting with various Capture The Flag (CTF) platforms. It allows you to automate tasks like fetching challenges, submitting flags, and accessing scoreboard data across different CTF systems without needing to learn each platform's specific API.

Q2: Which CTF platforms are currently supported?¶

CTFBridge supports several popular platforms, including CTFd, rCTF, HTB (Hack The Box CTF events), Berg, and EPT. For a detailed and up-to-date list, please see our Supported Platforms page.

Q3: How do I install CTFBridge?¶

You can install CTFBridge using pip:

pip install ctfbridge

Q4: Do I need to know which platform a CTF is running on to use CTFBridge?¶

Not necessarily! CTFBridge includes an automatic platform detection feature. You can usually just provide the base URL of the CTF, and the library will attempt to identify the platform and use the correct adapter. You can also specify the platform manually for faster initialization.

Q5: Is CTFBridge synchronous or asynchronous?¶

CTFBridge is designed with an async-first approach, making it suitable for I/O-bound operations typically found in web interactions and ideal for modern automation scripts and tools. All primary interactions with the client will use async and await.

Yes, CTFBridge provides session management capabilities, including saving your current session (cookies, headers) to a file and loading it later. This allows for persistent sessions across script runs.

Q7: How can I contribute to CTFBridge?¶

Contributions are very welcome! We appreciate help with bug reports, feature requests, code enhancements, documentation improvements, or adding support for new platforms. Please read our Contributing Guidelines to get started.

Q8: Where can I find detailed API documentation?¶

You can find detailed documentation for the client interface and data models in the API Reference section of our documentation.

Q9: What if a CTF platform I use isn't supported?¶

CTFBridge is designed to be extensible. If you'd like to add support for a new platform, please refer to our Developer Guide on Platform Integration. You can also open a feature request on our GitHub issues page.

Q10: What is "Challenge Enrichment"?¶

Challenge enrichment refers to the process where CTFBridge attempts to extract additional useful information from challenge data that might not be explicitly provided by the platform's API in a structured way. This can include parsing authors, attachments, or service details (like nc host port) directly from challenge descriptions.