nessusTransporter

Documentation

Overview

Package nessusTransporter is used to transport results from a remote Nessus host to the local machine.

Index

• type SSHAuth
  • func NewSSHAuth(username, password string) SSHAuth
• type SSHKey
  • func NewSSHKey(pathToKeyFile, keyFilename string) SSHKey
• type TargetHost
  • func NewTargetHost(hostname, port string) TargetHost
• type Transporter
  • func NewTransporter(sshKey SSHKey, auth SSHAuth, targetHost TargetHost, withSSHAgent, debug bool) *Transporter
  • func (t *Transporter) Connect() error
  • func (t *Transporter) RetrieveResultFiles(remoteResultsPath, localResultsPath string, removeFiles bool) error

Types

type SSHAuth

type SSHAuth struct {
	Username string
	// contains filtered or unexported fields
}

SSHAuth includes the details necessary to authenticate with a remote host

func NewSSHAuth

func NewSSHAuth(username, password string) SSHAuth

NewSSHAuth returns an SSHAuth instance for use by the transporter

type SSHKey

type SSHKey struct {
	PathToFile  string
	KeyFilename string
}

SSHKey includes details necessary to locate SSH Keys used for a session.

func NewSSHKey

func NewSSHKey(pathToKeyFile, keyFilename string) SSHKey

NewSSHKey returns a SSHKey instance for use by the transporter

type TargetHost

type TargetHost struct {
	Host string
	Port string
}

TargetHost includes information about the remote host that result files should be retrieved by.

func NewTargetHost

func NewTargetHost(hostname, port string) TargetHost

NewTargetHost returns a target host instance for use by the transporter

type Transporter

type Transporter struct {
	SSHKey       SSHKey
	SSHAuth      SSHAuth
	TargetHost   TargetHost
	WithSSHAgent bool
	Client       *ssh.Client
	// contains filtered or unexported fields
}

Transporter holds all information necessary to transport result files.

func NewTransporter

func NewTransporter(sshKey SSHKey, auth SSHAuth, targetHost TargetHost,
	withSSHAgent, debug bool) *Transporter

NewTransporter returns an instance of the Transporter structure

func (*Transporter) Connect

func (t *Transporter) Connect() error

Connect creates an SSH Client which is used to transport Nessus result files

func (*Transporter) RetrieveResultFiles

func (t *Transporter) RetrieveResultFiles(remoteResultsPath, localResultsPath string, removeFiles bool) error

RetrieveResultFiles retrieves files from a remote path and copies them to the local machine