api

package
v1.1.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 24, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (

	// ErrDateMalformed indicates that the date format does not comply with YYYY-MM-DD.
	ErrDateMalformed = errors.New("Malformed Date")

	// ErrPageMalformed indicates that the page requested is not an integer larger than 0.
	ErrPageMalformed = errors.New("Malformed Page Number")

	// ErrPageNotFound indicates that the page requested does not exist.
	ErrPageNotFound = errors.New("Page Not Found")

	// ErrSizeMalformed indicates that the size requested is not an integer larger than 0.
	ErrSizeMalformed = errors.New("Malformed Size Number")

	// ErrSizeTooLarge indicates that the size requested is larger than the maximum allowed.
	ErrSizeTooLarge = errors.New("Size Number Too Large")

	// ErrInvalidFilter indicates that there is a conflict between specified params for the filter.
	ErrInvalidFilter = errors.New("Filter parameters combination is invalid")
)

Functions

This section is empty.

Types

type API 

type API struct {
	Options Options
	// contains filtered or unexported fields
}

API holds the storage interface and related methods.

func New 

func New(s storage.Storage, options Options) *API

New instantiates a new API.

func (*API) CreateTarget 

func (api *API) CreateTarget(c echo.Context) error

CreateTarget creates a new target or, if the target already exists, associates the given teams to it.

func (*API) DeleteTargetTeam added in v1.1.0 

func (api *API) DeleteTargetTeam(c echo.Context) error

DeleteTargetTeam deletes the association between a target and a team.

func (*API) DeleteTeam added in v1.1.0 

func (api *API) DeleteTeam(c echo.Context) error

DeleteTeam deletes all target associations for a team.

func (*API) GetFinding 

func (api *API) GetFinding(c echo.Context) error

GetFinding returns a JSON containing a specific finding.

func (*API) GetFindingFromTargetIssueAndResource 

func (api *API) GetFindingFromTargetIssueAndResource(c echo.Context) error

GetFindingFromTargetIssueAndResource returns a JSON containing a specific finding which is associated to the specified target ID, issue ID and affected resource. NOTE: this endpoint will work only in a few cases because the affected resource is an arbitrary string, not an ID.

func (*API) GetFindingMTTR 

func (api *API) GetFindingMTTR(c echo.Context) error

GetFindingMTTR returns a JSON containing the mean time to remediate a finding.

func (*API) GetIssue 

func (api *API) GetIssue(c echo.Context) error

GetIssue returns a JSON containing a specific issue.

func (*API) GetIssueMTTR 

func (api *API) GetIssueMTTR(c echo.Context) error

GetIssueMTTR returns a JSON containing the mean time to remediate an issue.

func (*API) GetSource 

func (api *API) GetSource(c echo.Context) error

GetSource returns a JSON containing a specific source.

func (*API) GetSourceMTTR 

func (api *API) GetSourceMTTR(c echo.Context) error

GetSourceMTTR returns the mean time to remediation for a specific source.

func (*API) GetTarget 

func (api *API) GetTarget(c echo.Context) error

GetTarget returns a JSON containing a specific target.

func (*API) GetTargetMTTR 

func (api *API) GetTargetMTTR(c echo.Context) error

GetTargetMTTR returns a JSON containing the mean time to remediate findings in a target.

func (*API) Healthcheck 

func (api *API) Healthcheck(c echo.Context) error

Healthcheck performs a simple query and returns an OK response.

func (*API) IssuesSummary 

func (api *API) IssuesSummary(c echo.Context) error

IssuesSummary returns a summary of affected assets by issue.

func (*API) ListFindingEvents 

func (api *API) ListFindingEvents(c echo.Context) error

ListFindingEvents returns a paginated JSON containing finding events.

func (*API) ListFindingEventsByFinding 

func (api *API) ListFindingEventsByFinding(c echo.Context) error

ListFindingEventsByFinding returns a paginated JSON containing finding events for a specific finding.

func (*API) ListFindings 

func (api *API) ListFindings(c echo.Context) error

ListFindings returns a paginated JSON containing findings.

func (*API) ListFindingsByIssue 

func (api *API) ListFindingsByIssue(c echo.Context) error

ListFindingsByIssue returns a paginated JSON containing findings for a specific issue.

func (*API) ListFindingsBySource 

func (api *API) ListFindingsBySource(c echo.Context) error

ListFindingsBySource returns a paginated JSON containing findings for a specific source.

func (*API) ListFindingsByTarget 

func (api *API) ListFindingsByTarget(c echo.Context) error

ListFindingsByTarget returns a paginated JSON containing findings for a specific target.

func (*API) ListIssues 

func (api *API) ListIssues(c echo.Context) error

ListIssues returns a paginated JSON containing issues.

func (*API) ListLabels 

func (api *API) ListLabels(c echo.Context) error

ListLabels returns a JSON containing existing labels for the applied filter.

func (*API) ListSources 

func (api *API) ListSources(c echo.Context) error

ListSources returns a paginated JSON containing sources.

func (*API) ListTargets 

func (api *API) ListTargets(c echo.Context) error

ListTargets returns a paginated JSON containing targets.

func (*API) PatchFinding 

func (api *API) PatchFinding(c echo.Context) error

PatchFinding updates parts of a finding and returns a JSON containing the modified finding.

func (*API) StatsAssets 

func (api *API) StatsAssets(c echo.Context) error

StastAssetsPerSeverity returns statistics about the highest severity open vulnerability per asset and matching the specified filters.

func (*API) StatsCurrentExposure 

func (api *API) StatsCurrentExposure(c echo.Context) error

StastCurrentExposure returns statistics about the current exposure times matching specific filters.

func (*API) StatsExposure 

func (api *API) StatsExposure(c echo.Context) error

StastExposure returns statistics about the exposure times matching specific filters.

func (*API) StatsFixedIssues 

func (api *API) StatsFixedIssues(c echo.Context) error

StatsFixedIssues returns statistics about the number of FIXED findings for each issue severity.

func (*API) StatsIssues 

func (api *API) StatsIssues(c echo.Context) error

StatsIssues returns a paginated JSON containing issues from a set of finding events.

func (*API) StatsMTTR 

func (api *API) StatsMTTR(c echo.Context) error

StatsMTTR returns statistics about the mean time to remediate for each issue severity.

func (*API) StatsOpenIssues 

func (api *API) StatsOpenIssues(c echo.Context) error

StatsOpenIssues returns statistics about the number of OPEN findings for each issue severity.

func (*API) StatsSize 

func (api *API) StatsSize(c echo.Context) error

StatsSize returns statistics about the size of each data set.

func (*API) TargetsSummary 

func (api *API) TargetsSummary(c echo.Context) error

TargetsSummary returns a summary of findings count and score by target.

type Options 

type Options struct {
	MaxSize     int
	DefaultSize int
}

Options holds the configurations options for the API.

type Pagination 

type Pagination struct {
	Limit  int  `json:"limit"`
	Offset int  `json:"offset"`
	Total  int  `json:"total"`
	More   bool `json:"more"`
}

Pagination holds response pagination information.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.