common

package

v0.0.0-...-3934c66 Latest Latest Go to latest Published: Dec 21, 2019 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/codekidX/cloak

Documentation ¶

Index ¶

func CheckForCloakCert() (string, string, error)
func DecodeCert() string
type Config
- func (c *Config) Groom()
- func (c *Config) Validate() bool
type DBConnector
type Executor
type ExecutorFile
type Stratergy
type Task

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckForCloakCert ¶

func CheckForCloakCert() (string, string, error)

CheckForCloakCert is a function to check if certificate file is present if not create one

func DecodeCert ¶

func DecodeCert() string

DecodeCert idk why it is needed will be removed

Types ¶

type Config ¶

type Config struct {
	Cloakboard bool        `json:"cloakboard"`
	Executors  []Executor  `json:"executors"`
	Connector  DBConnector `json:"connector"`
	PickTime   string      `json:"pick_time"`
}

Config is the global configuration struct for configuring the cloak server

func (*Config) Groom ¶

func (c *Config) Groom()

Groom does some checks for the values which are not mandatory like port of executors or db connector user and passwords reason is because they can be replaced by their default values

func (*Config) Validate ¶

func (c *Config) Validate() bool

Validate checks if all the options are correctly configured and this can also be done by doing

cloak test

type DBConnector ¶

type DBConnector struct {
	Stratergy Stratergy `json:"stratergy"`
	DBName    string    `json:"db"`
	Address   string    `json:"addr"`
	Username  string    `json:"user"`
	Password  string    `json:"pwd"`
}

DBConnector is a connector definition

type Executor ¶

type Executor struct {
	Name    string `json:"name"`
	Address string `json:"addr"`
}

Executor is the executor child running on node

type ExecutorFile ¶

type ExecutorFile struct {
	Tasks []Task `json:"tasks"`
}

ExecutorFile is executor file that has the tasks and it's CTF

type Stratergy ¶

type Stratergy string

Stratergy that mentiones the type of connector that you want cloak to use

const (
	// Local stratergy just saves every tasks inside BoltDB
	Local Stratergy = "local"
	// PSQL saves tasks into postgreSQL database
	PSQL Stratergy = "plsql"
)

type Task ¶

type Task struct {
	ExecutorName string `json:"executorName"`
	Context      string `json:"context"`
	Ctf          string `json:"ctf"`
	Command      string `json:"cmd"`
}

Task defines a basic contruct for a cloak task

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL