CipherSwarm Agent

The CipherSwarm Go Agent is a high-performance component of the CipherSwarm ecosystem. It is designed to efficiently manage and execute distributed hash-cracking tasks. Built with Go, this agent provides a robust solution for scaling and managing cryptographic computations across the CipherSwarm network.

Features

Command-Line Interface: Utilizes the Cobra library for easy configuration and operation through command-line commands.
Efficient Task Management: Streamlines the distribution and execution of hash-cracking tasks across distributed systems.
Scalable and High-Performance: Optimized for performance and scalability, handling heavy computational tasks efficiently.
Secure Communication: Ensures safe and reliable communication with the CipherSwarm server for task distribution and result submission.

Caution

This project is currently under active development and is not ready for production. Please use it with caution. Do not trust anything until v1.0.0 is released since the API may change at any time.

Getting Started

Follow these instructions to set up and run the CipherSwarm Agent in your environment.

Prerequisites

Go 1.22 or higher
Git (for cloning the repository)
Docker (optional for running the agent in a container)
A CipherSwarm server to connect to (e.g., a local or remote instance)

Installation

Clone the repository:

git clone https://github.com/unclesp1d3r/cipherswarm-agent.git
cd cipherswarm-agent

Build the agent using Go:

go build -o cipherswarm-agent

Configuration

The easiest way to configure the agent is by providing the required parameters as environment variables. The following are the available configuration options:

API_TOKEN: The API token for the CipherSwarm server. This token is provided when the agent is added to the CipherSwarm server.
API_URL: The URL of the CipherSwarm server. This is the URL where the CipherSwarm server runs, e.g., https://cipherswarm.example.com:3000.

Optional configuration options include:

DATA_PATH: The path to the directory where the agent will store data, such as task files and results. By default, this is set to "data" in the current directory.
GPU_TEMP_THRESHOLD: The temperature threshold for the GPU is degrees Celsius. If the GPU temperature exceeds this threshold, the agent will pause task execution until the temperature drops below the threshold. By default, this is set to 80 degrees Celsius.
ALWAYS_USE_NATIVE_HASHCAT: If set to true, the agent will always use the native hashcat binary on the local system for task execution, even if a custom binary is provided in the web interface. By default, this is set to false.
SLEEP_ON_FAILURE: A duration of sleep after a task failure. By default, this is set to 60 seconds.
FILES_PATH: The path to the directory where the agent will store task files. This is set to "files" in the data directory by default. These files include wordlists, rules, and masks. They can get pretty big, so make sure you have enough space.
EXTRA_DEBUGGING: The agent will print additional debugging information to the console if set to true. By default, this is set to false.
STATUS_TIMER: The interval in seconds at which the agent will send status updates to the server. By default, this is set to 3 seconds. This can be increased to reduce the load on the server, but it will also reduce the agent's responsiveness.

Optional configuration options for using the ZAP feature with a shared directory:

WRITE_ZAPS_TO_FILE: The agent will write the zap output to a file in the zaps directory if set to true. By default, this is set to false. This is useful for debugging and sharing zap output with other clients via a shared directory. The server will still prompt the agent to download the Zap output files, but this can be useful if you want to share the Zap output with other clients.
ZAP_PATH: The path to the directory where the agent will store the zap output files. This is set to " zap" in the data directory by default. These files contain successful cracks, and setting this is sometimes used to allow multiple clients to share cracks via a shared directory rather than the server.
RETAIN_ZAPS_ON_COMPLETION: If set to true, the agent will retain the zap files after completing a task. Otherwise, the zap path contents are deleted upon completion of each task. By default, this is set to false.

The agent will automatically create a configuration file in the same directory as the agent (cipherswarmagent.yaml) with the provided configuration options and default options that can be modified.

Command Line Flags

The agent can also be configured using command line flags. The following flags are available:

--api_token or -a: The API token for the CipherSwarm server.
--api_url or -u: The URL of the CipherSwarm server.
--data_path or -p: The path to the directory where the agent will store data.
--gpu_temp_threshold or -g: The temperature threshold for the GPU in degrees Celsius.
--always_use_native_hashcat or -n: Force using the native hashcat binary.
--sleep_on_failure or -s: Duration of sleep after a task failure.
--files_path or -f: The path to the directory where the agent will store task files.
--extra_debugging or -e: Enable additional debugging information.
--status_timer or -t: Interval in seconds for sending status updates to the server.
--write_zaps_to_file or -w: Write zap output to a file in the zaps directory.
--zap_path or -z: The path to the directory where the agent will store zap output files.
--retain_zaps_on_completion or -r: Retain zap files after completing a task.
--help or -h: Show help information.
--version or -v: Show the version of the agent.

Running the Agent

To start the agent, run the following:

./cipherswarm-agent

This will activate the agent, connecting it to the CipherSwarm network to begin receiving and processing tasks.

Docker

The easiest way to run the CipherSwarm Agent is by using Docker. To build the Docker image, run:

docker pull ghcr.io/unclesp1d3r/cipherswarmagent:latest

docker run -e API_TOKEN=your_api_token -e API_URL=https://cipherswarm.example.com:3000 ghcr.io/unclesp1d3r/cipherswarmagent:latest

This will start the agent in a Docker container, connecting it to the CipherSwarm network with Hashcat and other dependencies that have been pre-installed.

Contributing

We welcome contributions! To contribute to the CipherSwarm Go Agent, please fork the repository, create a feature branch, push your changes, and submit a pull request.

Conventional Commits

From now on, we will use Conventional Commits for our commit messages. This will help us automate the release process and generate changelogs. Please follow the commit message format below:

<type>[optional scope]: <description>

        [optional body]

        [optional footer(s)]

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

Acknowledgments

The CipherSwarm Team and community thank you for your support and inspiration.
The creators and maintainers of the Cobra library and GoReleaser for their fantastic tools.
The developers and contributors to the PhatCrack project gave us hints and ideas for this project.

unclesp1d3r/CipherSwarmAgent