tasks

Documentation

Overview

The tasks package contains all the tasks Dexter can run.

To add a new task, start by making a copy of the example file.

Index

• Variables
• type ArtifactWriter
  • func (writer *ArtifactWriter) Error(message string)
  • func (writer *ArtifactWriter) Write(dst string, data []byte)
• type Task
  • func (task *Task) Run(dir string, args []string)

Variables

var Tasks = map[string]Task{}

All tasks in Dexter are stored here, added using the `add` function in the files that define the tasks.

Types

type ArtifactWriter

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

An ArtifactWriter helps you create files in the correct path for a report.

func (*ArtifactWriter) Error

func (writer *ArtifactWriter) Error(message string)

Write an error into a tasks's report

func (*ArtifactWriter) Write

func (writer *ArtifactWriter) Write(dst string, data []byte)

Write a file to the filesystem, logging any errors

type Task

type Task struct {
	Name                 string
	Description          string
	MinimumArguments     int
	ConsensusRequirement int
	// contains filtered or unexported fields
}

A Task defines something Dexter can do on a host.

func (*Task) Run

func (task *Task) Run(dir string, args []string)

Run the Task's actionFunction unless Dexter isn't running on a platform the task supports.