ExploitFarm Python Library and CLI
ExploitFarm is an advanced tool designed to manage exploits and flag submissions in Attack-Defense CTF competitions. It combines a Python library with a command-line interface (CLI), providing flexibility and efficiency for managing CTF tasks. This documentation provides a comprehensive overview of its features, installation, and usage.
Key Features
-
Multi-Threaded Execution: Utilize a pool of worker threads for efficient exploit execution.
-
Exploit Management: Initialize, push, pull, and version control exploit source code.
-
Attack Groups: Collaborate and manage group-based attacks.
-
Integrated Status Monitoring: View real-time server and current execution statuses.
Installation
Install ExploitFarm via pip:
pip3 install -U xfarm && xfarm --install-completion
For Windows, use:
python -m xfarm
Prerequisites:
- Python 3.8+
- Compatible with Linux, macOS, and Windows.
- Ensure you have
pipinstalled.
Getting Started
ExploitFarm provides both programmatic and CLI access to its features.
Programmatic API
The Python library allows developers to integrate ExploitFarm functionality into their scripts:
import random
from exploitfarm import *
host = get_host() # Retrieves the server host (from environment variables or configuration)
print(f"Connected to {host}")
flags = [random_str(32) + "=" for _ in range(10)]
print(f"Submitting flags: {flags}")
submit_flags(flags)
Store Class
The Store class provides a key-value storage system for exploits, allowing you to save and retrieve centralized data during execution.
The key value store is by default isolated per exploit id.
If you need data shared between exploits you should use a custom context_id that allows to access the same data from different exploits. The context_id can be set also in the constructor of the Store class, and will be used as default context_id for all the calls with that store instance.
from exploitfarm import Store
# Initialize with an optional default context
store = Store(default_context_id="my_global_context_id")
# Set a value (context_id can be overridden per call)
store.set("example_key", {"example": "data"})
store.set("other_key", "value", context_id="explicit_ctx")
# Get a value (if not exists returns None)
data = store.get("example_key")
print(data)
# Delete a key
store.delete("example_key")
# List all keys in the current context
keys = store.keys()
print(keys)
# List all available contexts
contexts = store.contexts()
print(contexts)
# Delete an entire context
store.delete_context(context_id="explicit_ctx")
Methods:
get(key: str, default=None, context_id: str | None = None, timeout: int = HTTP_TIMEOUT) -> any: Retrieve and deserialize a value by key.get_bytes(key: str, default=None, context_id: str | None = None, timeout: int = HTTP_TIMEOUT) -> bytes: Retrieve a raw byte value.set(key: str, value: any, context_id: str | None = None, timeout: int = HTTP_TIMEOUT): Serialize and store a value by key.set_bytes(key: str, value: bytes, context_id: str | None = None, timeout: int = HTTP_TIMEOUT): Store a raw byte value.delete(key: str, context_id: str | None = None, timeout: int = HTTP_TIMEOUT): Delete a key.keys(timeout: int = HTTP_TIMEOUT, context_id: str | None = None) -> list[str]: List all stored keys in a context.contexts(timeout: int = HTTP_TIMEOUT) -> list[str]: List all available contexts.delete_context(context_id: str | None = None, timeout: int = HTTP_TIMEOUT): Delete an entire context and its keys.
Environment Variables Required:
XFARM_REMOTE_URL: Base URL for the exploit storage API.XFARM_EXPLOIT_ID: Unique identifier for the exploit.XFARM_LOGIN_TOKEN: Authentication token for secure access.
Command-Line Interface (CLI)
The CLI is the primary way to interact with ExploitFarm for exploit and attack management.
CLI Syntax
xfarm [COMMAND] [OPTIONS]
Use --help to view available commands and options:
xfarm --help
Detailed CLI Documentation
Global Options
These options are applicable to all commands:
-h,--help: Display help information for a command.-I,--no-interactive: Disable interactive configuration mode (default: interactive).-v,--version: Show the version of the ExploitFarm client.
Primary Commands
Start Exploit
Run an exploit from the specified path:
xfarm start [OPTIONS] PATH
Options:
PATH: The directory containing the exploit (default: current directory).--pool-size, -p: Fixed size for the thread pool (default:10 * CPU cores).--submit-pool-timeout: Timeout (in seconds) for the submission pool (default: 3).--test, -t: Test the exploit without submission.--test-timeout: Timeout for exploit testing (default: 30 seconds).--no-auto-push, -n: Prevent automatic source push.--push-message, -m: Custom message for the source push.
Example:
xfarm start ./my_exploit --pool-size 20 --test
Configuration Commands
Edit Configuration
Edit client settings:
xfarm config edit [OPTIONS]
Options:
--address: Server address.--port: Server port.--nickname: Client nickname.--https: Use HTTPS (default: False).
Example (no interactive mode):
xfarm -I config edit --address example.com --port 443 --https --nickname
Reset Configuration
Reset all client settings to their default values:
xfarm config reset
Login
Authenticate with the server:
xfarm config login [OPTIONS]
Options:
--password: Provide the password directly.--stdin: Read the password from stdin.
Logout
Logout from the server:
xfarm config logout
Exploit Management Commands
Initialize Exploit
Set up a new exploit project:
xfarm init [OPTIONS]
Options:
--edit, -e: Edit the configuration interactively.--name: Exploit name.--service: Associated service UUID.--language: Programming language.
Push Exploit
Upload the exploit source code to the server:
xfarm push [OPTIONS]
Options:
--message, -m: Commit message.--force, -f: Force push even with an old commit has the same source.
Retrieve Exploit Information
Get details about the exploit source:
xfarm log [OPTIONS]
Options:
--raw, -r: Display raw JSON response.
Update Exploit
Update to the latest commit:
xfarm pull [OPTIONS]
Options:
--force, -f: Force update.
Download Exploit
Download the exploit source:
xfarm clone [OPTIONS]
Options:
--folder, -f: Specify target folder.--commit-uuid: Commit ID (default: latest).
Attack Group Commands
Create Attack Group
Create a new group for collaborative attacks (and also join in it if in interactive mode):
xfarm group create [OPTIONS]
Options:
--name: Group name.
Join Attack Group
Join an existing attack group:
xfarm group join [OPTIONS]
Options:
--group: Group ID.--queue: Queue number for the group.--submit-pool-timeout: Timeout for submission pooling.--demonizedor-d: Join the group in a demonized process.--kill: Kill a running worker of the indicated group.--log-file: Path to the log file
List Attack Group
List all available attack groups:
xfarm group list
Shows a table with all existing groups, their IDs, and if there is a worker running for that group.
Environment Variables
Environment variables can simplify configuration:
XFARM_HOST: Server address.XFARM_PORT: Server port.XFARM_INTERACTIVE: Enable or disable interactive mode.XFARM_REMOTE_URL: API Base URL for remote exploit storage.XFARM_EXPLOIT_ID: Unique identifier for the exploit.XFARM_LOGIN_TOKEN: Authentication token for secure access.
Best Practices
- Use
--testto verify exploits before running them in production. - Regularly push changes to the server for version control (they are auto-pushed on attack start anyway).
- Collaborate using attack groups for efficient resource utilization if the attack is heavy to execute.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file exploitfarm-1.7.9.tar.gz.
File metadata
- Download URL: exploitfarm-1.7.9.tar.gz
- Upload date:
- Size: 61.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c869ba7d88193e668aed319aacbb574921c309db5bfa7d6f23f9d9f973f3a51
|
|
| MD5 |
f5299373d0d8b2166d5845f8614bec25
|
|
| BLAKE2b-256 |
a0d5f05d6cf3ab748ab32f5c8dd3aae81208b6df0f770a6d1ed4c67376d5186b
|
File details
Details for the file exploitfarm-1.7.9-py3-none-any.whl.
File metadata
- Download URL: exploitfarm-1.7.9-py3-none-any.whl
- Upload date:
- Size: 71.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f94820e41f6cca2b06f942fef7521a8447b45f2119e0b3528957de6a18bedb1a
|
|
| MD5 |
54fdda12e317ac6de344ed47439a46da
|
|
| BLAKE2b-256 |
db1d24ad391117f159d421243abe2fca20d125d0a5b34413068b3296e5042ccc
|
