CipherSwarm Agent SDK for Go

Welcome to the CipherSwarm Agent SDK for Go! This SDK provides the tools you need to write agents for the CipherSwarm platform. CipherSwarm is a powerful, distributed system for secure, scalable data processing and analysis.

Features

• Agent Creation: Easily create and manage agents for the CipherSwarm platform.
• Secure Communication: Utilize built-in encryption and authentication mechanisms to ensure secure communication between agents and the CipherSwarm network.
• Scalability: Designed to handle high-throughput data processing tasks with ease.
• Extensibility: Flexible architecture allows for customization and extension of agent functionality.

Getting Started

Prerequisites

• Go 1.16 or later
• A working installation of the CipherSwarm platform. Refer to the CipherSwarm documentation for setup instructions.

Summary

CipherSwarm Agent API: The CipherSwarm Agent API is used to allow agents to connect to the CipherSwarm server.

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Special Types

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/unclesp1d3r/cipherswarm-agent-sdk-go

SDK Example Usage

Example

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Agents

• GetAgent - Gets an instance of an agent
• UpdateAgent - Updates the agent
• SendHeartbeat - Send a heartbeat for an agent
• SubmitBenchmark - submit agent benchmarks
• SubmitErrorAgent - Submit an error for an agent
• SetAgentShutdown - shutdown agent

Attacks

• GetAttack - show attack
• GetHashList - Get the hash list

Client

• GetConfiguration - Get Agent Configuration
• Authenticate - Authenticate Client

Crackers

• CheckForCrackerUpdate - Check for Cracker Update

Tasks

• GetNewTask - Request a new task from server
• GetTask - Request the task information
• SendCrack - Submit a cracked hash result for a task
• SendStatus - Submit a status update for a task
• SetTaskAccepted - Accept Task
• SetTaskExhausted - Notify of Exhausted Task
• SetTaskAbandoned - Abandon Task
• GetTaskZaps - Get Completed Hashes

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the GetAgent function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.ErrorObject	401	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Example

package main

import (
	"context"
	"errors"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"github.com/unclesp1d3r/cipherswarm-agent-sdk-go/models/sdkerrors"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {

		var e *sdkerrors.ErrorObject
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://{defaultHost}	defaultHost (default is www.example.com)
1	http://{hostAddress}:{hostPort}	hostAddress (default is localhost), hostPort (default is 8080)

Example

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithServerIndex(1),
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:

• WithDefaultHost string
• WithHostAddress string
• WithHostPort string

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithServerURL("https://{defaultHost}"),
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
BearerAuth	http	HTTP Bearer

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Special Types

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"github.com/unclesp1d3r/cipherswarm-agent-sdk-go/retry"
	"log"
	"models/operations"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	cipherswarmagentsdkgo "github.com/unclesp1d3r/cipherswarm-agent-sdk-go"
	"github.com/unclesp1d3r/cipherswarm-agent-sdk-go/retry"
	"log"
)

func main() {
	s := cipherswarmagentsdkgo.New(
		cipherswarmagentsdkgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, 135003)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update.

Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically from the CipherSwarm API specification. As a result, we are unable to accept pull requests for changes to the SDK itself. However, we are always looking for ways to improve the SDK and make it more useful for developers. If you have an idea for a new feature or improvement, please open an issue on the GitHub repository.

SDK Created by Speakeasy