libs

Documentation

Index

• Constants
• Variables
• type Environment
• type Log
• type Module
• type Options
• type Routine
• type Scan
• type Step
• type Workflow

Constants

const (
	VERSION   = "v1.0.0"
	NAME      = "leviathan"
	SHORTNAME = "lvt"
	DESC      = "A workflow engine for OffSec inspired by Osmedeus"
	AUTHOR    = "@y0no"
	DOCS      = "https://leviathan.y0no.fr"
)

Variables

var CONFIGFILE = fmt.Sprintf("~/.config/%s/config.yaml", NAME)

var LOGDIR = fmt.Sprintf("/tmp/%s-log", SHORTNAME)

Types

type Environment

type Environment struct {
	Workspaces string
	Workflows  string
	Modules    string
	Binaries   string
}

type Log

type Log struct {
	JSON      bool
	Directory string
	Debug     bool
	Quiet     bool
}

type Module

type Module struct {
	Name        string
	Description string

	Params []map[string]string

	Reports []string
	PreRun  []string `yaml:"pre_run"`
	Steps   []Step
	PostRun []string `yaml:"post_run"`
}

type Options

type Options struct {
	Scan        Scan
	Log         Log
	ConfigFile  string
	Environment Environment
}

type Routine

type Routine struct {
	Modules []string
	Params  []map[string]string
}

type Scan

type Scan struct {
	Flow    string
	Threads int
	Targets []string
	Params  map[string]string
	Output  string
	NoClean bool
	Resume  bool
}

type Step

type Step struct {
	Requirements []string
	Conditions   []string

	// Define specific source file for a step
	Source string

	// Executed if conditions are met
	Commands []string
	Scripts  []string

	// Executed if conditions are not met
	RCommands []string
	RScripts  []string
}

type Workflow

type Workflow struct {
	Name        string
	Description string
	Author      string
	Validator   string

	Params   []map[string]string
	Routines []Routine
}