cipherswarmagentsdkgo

package module
v0.7.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 6, 2024 License: MPL-2.0 Imports: 14 Imported by: 2

README

CipherSwarm Agent SDK for Go

Made With SpeakEasy GitHub License Go Reference

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.

SDK Installation

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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	if err != nil {
		log.Fatal(err)
	}
	if res.Agent != nil {
		// handle response
	}
}

Available Resources and Operations

Agents
Attacks
Crackers
Tasks
Client

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. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object 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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id, 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>"),
	)
	var id int64 = 135003
	ctx := context.Background()
	res, err := s.Agents.GetAgent(ctx, id)
	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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ServerList = []string{

	"https://{defaultHost}",

	"http://{hostAddress}:{hostPort}",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type Agents 

type Agents struct {
	// contains filtered or unexported fields
}

Agents API

func (*Agents) GetAgent added in v0.2.0 

func (s *Agents) GetAgent(ctx context.Context, id int64, opts ...operations.Option) (*operations.GetAgentResponse, error)

GetAgent - Gets an instance of an agent Returns an agent

func (*Agents) SendHeartbeat added in v0.2.0 

func (s *Agents) SendHeartbeat(ctx context.Context, id int64, opts ...operations.Option) (*operations.SendHeartbeatResponse, error)

SendHeartbeat - Send a heartbeat for an agent Send a heartbeat for an agent to keep it alive.

func (*Agents) SetAgentShutdown added in v0.4.0 

func (s *Agents) SetAgentShutdown(ctx context.Context, id int64, opts ...operations.Option) (*operations.SetAgentShutdownResponse, error)

SetAgentShutdown - shutdown agent Marks the agent as shutdown and offline, freeing any assigned tasks.

func (*Agents) SubmitBenchmark added in v0.2.0 

func (s *Agents) SubmitBenchmark(ctx context.Context, id int64, requestBody operations.SubmitBenchmarkRequestBody, opts ...operations.Option) (*operations.SubmitBenchmarkResponse, error)

SubmitBenchmark - submit agent benchmarks Submit a benchmark for an agent

func (*Agents) SubmitErrorAgent added in v0.2.2 

func (s *Agents) SubmitErrorAgent(ctx context.Context, id int64, requestBody *operations.SubmitErrorAgentRequestBody, opts ...operations.Option) (*operations.SubmitErrorAgentResponse, error)

SubmitErrorAgent - Submit an error for an agent Submit an error for an agent

func (*Agents) UpdateAgent 

func (s *Agents) UpdateAgent(ctx context.Context, id int64, requestBody *operations.UpdateAgentRequestBody, opts ...operations.Option) (*operations.UpdateAgentResponse, error)

UpdateAgent - Updates the agent Updates an agent

type Attacks 

type Attacks struct {
	// contains filtered or unexported fields
}

Attacks API

func (*Attacks) GetAttack added in v0.2.0 

func (s *Attacks) GetAttack(ctx context.Context, id int64, opts ...operations.Option) (*operations.GetAttackResponse, error)

GetAttack - show attack Returns an attack by id. This is used to get the details of an attack.

func (*Attacks) GetHashList added in v0.2.0 

func (s *Attacks) GetHashList(ctx context.Context, id int64, opts ...operations.Option) (*operations.GetHashListResponse, error)

GetHashList - Get the hash list Returns the hash list for an attack.

type CipherSwarmAgentSDK 

type CipherSwarmAgentSDK struct {
	// Agents API
	Agents *Agents
	// Attacks API
	Attacks *Attacks
	// Crackers API
	Crackers *Crackers
	// Tasks API
	Tasks *Tasks
	// Client API
	Client *Client
	// contains filtered or unexported fields
}

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

func New 

func New(opts ...SDKOption) *CipherSwarmAgentSDK

New creates a new instance of the SDK with the provided options

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client API

func (*Client) Authenticate 

func (s *Client) Authenticate(ctx context.Context, opts ...operations.Option) (*operations.AuthenticateResponse, error)

Authenticate Client Authenticates the client. This is used to verify that the client is able to connect to the server.

func (*Client) GetConfiguration added in v0.2.0 

func (s *Client) GetConfiguration(ctx context.Context, opts ...operations.Option) (*operations.GetConfigurationResponse, error)

GetConfiguration - Get Agent Configuration Returns the configuration for the agent.

type Crackers 

type Crackers struct {
	// contains filtered or unexported fields
}

Crackers API

func (*Crackers) CheckForCrackerUpdate 

func (s *Crackers) CheckForCrackerUpdate(ctx context.Context, operatingSystem *string, version *string, opts ...operations.Option) (*operations.CheckForCrackerUpdateResponse, error)

CheckForCrackerUpdate - Check for Cracker Update Check for a cracker update, based on the operating system and version.

type HTTPClient 

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

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type SDKOption 

type SDKOption func(*CipherSwarmAgentSDK)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithDefaultHost 

func WithDefaultHost(defaultHost string) SDKOption

WithDefaultHost allows setting the defaultHost variable for url substitution

func WithHostAddress 

func WithHostAddress(hostAddress string) SDKOption

WithHostAddress allows setting the hostAddress variable for url substitution

func WithHostPort 

func WithHostPort(hostPort string) SDKOption

WithHostPort allows setting the hostPort variable for url substitution

func WithRetryConfig 

func WithRetryConfig(retryConfig retry.Config) SDKOption

func WithSecurity 

func WithSecurity(bearerAuth string) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServerIndex 

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTimeout added in v0.6.0 

func WithTimeout(timeout time.Duration) SDKOption

WithTimeout Optional request timeout applied to each operation

type Tasks 

type Tasks struct {
	// contains filtered or unexported fields
}

Tasks API

func (*Tasks) GetNewTask added in v0.2.0 

func (s *Tasks) GetNewTask(ctx context.Context, opts ...operations.Option) (*operations.GetNewTaskResponse, error)

GetNewTask - Request a new task from server Request a new task from the server, if available.

func (*Tasks) GetTask added in v0.2.0 

func (s *Tasks) GetTask(ctx context.Context, id int64, opts ...operations.Option) (*operations.GetTaskResponse, error)

GetTask - Request the task information Request the task information from the server.

func (*Tasks) GetTaskZaps added in v0.7.0 

func (s *Tasks) GetTaskZaps(ctx context.Context, id int64, opts ...operations.Option) (*operations.GetTaskZapsResponse, error)

GetTaskZaps - Get Completed Hashes Gets the completed hashes for a task. This is a text file that should be added to the monitored directory to remove the hashes from the list during runtime.

func (*Tasks) SendCrack added in v0.2.0 

func (s *Tasks) SendCrack(ctx context.Context, id int64, hashcatResult *components.HashcatResult, opts ...operations.Option) (*operations.SendCrackResponse, error)

SendCrack - Submit a cracked hash result for a task Submit a cracked hash result for a task.

func (*Tasks) SendStatus added in v0.2.0 

func (s *Tasks) SendStatus(ctx context.Context, id int64, taskStatus components.TaskStatus, opts ...operations.Option) (*operations.SendStatusResponse, error)

SendStatus - Submit a status update for a task Submit a status update for a task. This includes the status of the current guess and the devices.

func (*Tasks) SetTaskAbandoned added in v0.2.0 

func (s *Tasks) SetTaskAbandoned(ctx context.Context, id int64, opts ...operations.Option) (*operations.SetTaskAbandonedResponse, error)

SetTaskAbandoned - Abandon Task Abandon a task. This will mark the task as abandoned. Usually used when the client is unable to complete the task.

func (*Tasks) SetTaskAccepted added in v0.2.0 

func (s *Tasks) SetTaskAccepted(ctx context.Context, id int64, opts ...operations.Option) (*operations.SetTaskAcceptedResponse, error)

SetTaskAccepted - Accept Task Accept an offered task from the server.

func (*Tasks) SetTaskExhausted added in v0.2.0 

func (s *Tasks) SetTaskExhausted(ctx context.Context, id int64, opts ...operations.Option) (*operations.SetTaskExhaustedResponse, error)

SetTaskExhausted - Notify of Exhausted Task Notify the server that the task is exhausted. This will mark the task as completed.

Source Files

View all Source files

Directories

Path Synopsis
internal
hooks
utils
models
components
operations
sdkerrors

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.