osp

Documentation

Index

• type Client
  • func New(host string, port int, ...) (*Client, error)
  • func (cl *Client) DeleteScan(uuid string) (*messages.DeleteScanResponse, error)
  • func (cl *Client) GetScan(uuid string, details bool) (*messages.GetScansResponse, error)
  • func (cl *Client) GetVersion() (*messages.GetVersionResponse, error)
  • func (cl *Client) Help() (*messages.HelpResponse, error)
  • func (cl *Client) StartScan(target string, portList ports.PortList, vtGroup []vtgroups.VtGroup, ...) (*messages.StartScanResponse, error)
  • func (cl *Client) StartScanV2(target string, portListTCP ports.PortList, portListUDP ports.PortList, ...) (*messages.StartScanResponse, error)
  • func (cl *Client) StopScan(uuid string) (*messages.StopScanResponse, error)

Types

type Client

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

Client struct with connection details of an OSP server

func New

func New(host string, port int, clientCertificatePath, clientKeyPath, certificateAuthorityPath string) (*Client, error)

Creates a client struct with the provided details

func (*Client) DeleteScan

func (cl *Client) DeleteScan(uuid string) (*messages.DeleteScanResponse, error)

Remove scan results on server

func (*Client) GetScan

func (cl *Client) GetScan(uuid string, details bool) (*messages.GetScansResponse, error)

Retrieve a scan result

func (*Client) GetVersion

func (cl *Client) GetVersion() (*messages.GetVersionResponse, error)

Get openvas version

func (*Client) Help

func (cl *Client) Help() (*messages.HelpResponse, error)

func (*Client) StartScan

func (cl *Client) StartScan(target string, portList ports.PortList, vtGroup []vtgroups.VtGroup, profile profiles.Profile) (*messages.StartScanResponse, error)

Start a new openvas scan with the provided details.

func (*Client) StartScanV2

func (cl *Client) StartScanV2(target string, portListTCP ports.PortList, portListUDP ports.PortList, vtGroup []vtgroups.VtGroup, profile profiles.Profile) (*messages.StartScanResponse, error)

func (*Client) StopScan

func (cl *Client) StopScan(uuid string) (*messages.StopScanResponse, error)

Stop a scan