descriptions

Documentation

Index

• func CheckVersion(t *tracker.CITracker)
• func RequestAndOverrideDescriptions(summary *model.Summary) error
• type Client
  • func (c *Client) CheckConnection() error
  • func (c *Client) CheckLatestVersion(version string) (model.Version, error)
  • func (c *Client) RequestDescriptions(descriptionIDs []string) (map[string]descModel.CISDescriptions, error)
• type HTTPClient
• type HTTPDescription

Functions

func CheckVersion

func CheckVersion(t *tracker.CITracker)

CheckVersion - checks if using the latest version and saves that information in the tracker

func RequestAndOverrideDescriptions

func RequestAndOverrideDescriptions(summary *model.Summary) error

RequestAndOverrideDescriptions - Requests descriptions and override default descriptions

Types

type Client

type Client struct {
}

Client - client for making descriptions requests

func (*Client) CheckConnection

func (c *Client) CheckConnection() error

CheckConnection - checks if the endpoint is reachable

func (*Client) CheckLatestVersion

func (c *Client) CheckLatestVersion(version string) (model.Version, error)

CheckLatestVersion - Check if using KICS latest version from endpoint

func (*Client) RequestDescriptions

func (c *Client) RequestDescriptions(descriptionIDs []string) (map[string]descModel.CISDescriptions, error)

RequestDescriptions - gets descriptions from endpoint

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient - http client to use for requests

var (

	// HTTPRequestClient - http client to use for requests
	HTTPRequestClient HTTPClient = &http.Client{
		Transport: tr,
		Timeout:   20 * time.Second,
	}
)

type HTTPDescription

type HTTPDescription interface {
	CheckConnection() error
	RequestDescriptions(descriptionIDs []string) (map[string]descModel.CISDescriptions, error)
	CheckLatestVersion(version string) (model.Version, error)
}

HTTPDescription - HTTP client interface to use for requesting descriptions