rest

Documentation

Index

• Constants
• type Server
  • func CreateRESTServer(port int, dbHandler databaseTypes.Database, uiSitePath string, ...) (*Server, error)
  • func (s *Server) Start(ctx context.Context, errChan chan struct{})
  • func (s *Server) Stop(ctx context.Context)
• type ServerImpl
  • func (s *ServerImpl) DeleteFindingsFindingID(ctx echo.Context, findingID models.FindingID) error
  • func (s *ServerImpl) DeleteScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID) error
  • func (s *ServerImpl) DeleteScansScanID(ctx echo.Context, scanID models.ScanID) error
  • func (s *ServerImpl) DeleteTargetsTargetID(ctx echo.Context, targetID models.TargetID) error
  • func (s *ServerImpl) GetDiscoveryScopes(ctx echo.Context, params models.GetDiscoveryScopesParams) error
  • func (s *ServerImpl) GetFindings(ctx echo.Context, params models.GetFindingsParams) error
  • func (s *ServerImpl) GetFindingsFindingID(ctx echo.Context, findingID models.FindingID, ...) error
  • func (s *ServerImpl) GetScanConfigs(ctx echo.Context, params models.GetScanConfigsParams) error
  • func (s *ServerImpl) GetScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, ...) error
  • func (s *ServerImpl) GetScanResults(ctx echo.Context, params models.GetScanResultsParams) error
  • func (s *ServerImpl) GetScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, ...) error
  • func (s *ServerImpl) GetScans(ctx echo.Context, params models.GetScansParams) error
  • func (s *ServerImpl) GetScansScanID(ctx echo.Context, scanID models.ScanID, params models.GetScansScanIDParams) error
  • func (s *ServerImpl) GetTargets(ctx echo.Context, params models.GetTargetsParams) error
  • func (s *ServerImpl) GetTargetsTargetID(ctx echo.Context, targetID models.TargetID, ...) error
  • func (s *ServerImpl) PatchFindingsFindingID(ctx echo.Context, findingID models.FindingID) error
  • func (s *ServerImpl) PatchScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, ...) error
  • func (s *ServerImpl) PatchScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, ...) error
  • func (s *ServerImpl) PatchScansScanID(ctx echo.Context, scanID models.ScanID, params models.PatchScansScanIDParams) error
  • func (s *ServerImpl) PatchTargetsTargetID(ctx echo.Context, targetID models.TargetID, ...) error
  • func (s *ServerImpl) PostFindings(ctx echo.Context) error
  • func (s *ServerImpl) PostScanConfigs(ctx echo.Context) error
  • func (s *ServerImpl) PostScanResults(ctx echo.Context) error
  • func (s *ServerImpl) PostScans(ctx echo.Context) error
  • func (s *ServerImpl) PostTargets(ctx echo.Context) error
  • func (s *ServerImpl) PutDiscoveryScopes(ctx echo.Context) error
  • func (s *ServerImpl) PutFindingsFindingID(ctx echo.Context, findingID models.FindingID) error
  • func (s *ServerImpl) PutScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, ...) error
  • func (s *ServerImpl) PutScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, ...) error
  • func (s *ServerImpl) PutScansScanID(ctx echo.Context, scanID models.ScanID, params models.PutScansScanIDParams) error
  • func (s *ServerImpl) PutTargetsTargetID(ctx echo.Context, targetID models.TargetID, ...) error

Constants

const (
	BaseURL          = "/api"
	UIBackendBaseURL = "/ui/api"
)

Types

type Server

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

func CreateRESTServer

func CreateRESTServer(port int, dbHandler databaseTypes.Database, uiSitePath string, uiBackendAPIImpl *uirest.ServerImpl) (*Server, error)

func (*Server) Start

func (s *Server) Start(ctx context.Context, errChan chan struct{})

func (*Server) Stop

func (s *Server) Stop(ctx context.Context)

type ServerImpl

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

func (*ServerImpl) DeleteFindingsFindingID

func (s *ServerImpl) DeleteFindingsFindingID(ctx echo.Context, findingID models.FindingID) error

func (*ServerImpl) DeleteScanConfigsScanConfigID

func (s *ServerImpl) DeleteScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID) error

func (*ServerImpl) DeleteScansScanID

func (s *ServerImpl) DeleteScansScanID(ctx echo.Context, scanID models.ScanID) error

func (*ServerImpl) DeleteTargetsTargetID

func (s *ServerImpl) DeleteTargetsTargetID(ctx echo.Context, targetID models.TargetID) error

func (*ServerImpl) GetDiscoveryScopes

func (s *ServerImpl) GetDiscoveryScopes(ctx echo.Context, params models.GetDiscoveryScopesParams) error

func (*ServerImpl) GetFindings

func (s *ServerImpl) GetFindings(ctx echo.Context, params models.GetFindingsParams) error

func (*ServerImpl) GetFindingsFindingID

func (s *ServerImpl) GetFindingsFindingID(ctx echo.Context, findingID models.FindingID, params models.GetFindingsFindingIDParams) error

func (*ServerImpl) GetScanConfigs

func (s *ServerImpl) GetScanConfigs(ctx echo.Context, params models.GetScanConfigsParams) error

func (*ServerImpl) GetScanConfigsScanConfigID

func (s *ServerImpl) GetScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, params models.GetScanConfigsScanConfigIDParams) error

func (*ServerImpl) GetScanResults

func (s *ServerImpl) GetScanResults(ctx echo.Context, params models.GetScanResultsParams) error

func (*ServerImpl) GetScanResultsScanResultID

func (s *ServerImpl) GetScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, params models.GetScanResultsScanResultIDParams) error

func (*ServerImpl) GetScans

func (s *ServerImpl) GetScans(ctx echo.Context, params models.GetScansParams) error

func (*ServerImpl) GetScansScanID

func (s *ServerImpl) GetScansScanID(ctx echo.Context, scanID models.ScanID, params models.GetScansScanIDParams) error

func (*ServerImpl) GetTargets

func (s *ServerImpl) GetTargets(ctx echo.Context, params models.GetTargetsParams) error

func (*ServerImpl) GetTargetsTargetID

func (s *ServerImpl) GetTargetsTargetID(ctx echo.Context, targetID models.TargetID, params models.GetTargetsTargetIDParams) error

func (*ServerImpl) PatchFindingsFindingID

func (s *ServerImpl) PatchFindingsFindingID(ctx echo.Context, findingID models.FindingID) error

func (*ServerImpl) PatchScanConfigsScanConfigID

func (s *ServerImpl) PatchScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, params models.PatchScanConfigsScanConfigIDParams) error

func (*ServerImpl) PatchScanResultsScanResultID

func (s *ServerImpl) PatchScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, params models.PatchScanResultsScanResultIDParams) error

nolint:cyclop

func (*ServerImpl) PatchScansScanID

func (s *ServerImpl) PatchScansScanID(ctx echo.Context, scanID models.ScanID, params models.PatchScansScanIDParams) error

func (*ServerImpl) PatchTargetsTargetID

func (s *ServerImpl) PatchTargetsTargetID(ctx echo.Context, targetID models.TargetID, params models.PatchTargetsTargetIDParams) error

func (*ServerImpl) PostFindings

func (s *ServerImpl) PostFindings(ctx echo.Context) error

func (*ServerImpl) PostScanConfigs

func (s *ServerImpl) PostScanConfigs(ctx echo.Context) error

func (*ServerImpl) PostScanResults

func (s *ServerImpl) PostScanResults(ctx echo.Context) error

func (*ServerImpl) PostScans

func (s *ServerImpl) PostScans(ctx echo.Context) error

func (*ServerImpl) PostTargets

func (s *ServerImpl) PostTargets(ctx echo.Context) error

nolint:cyclop

func (*ServerImpl) PutDiscoveryScopes

func (s *ServerImpl) PutDiscoveryScopes(ctx echo.Context) error

func (*ServerImpl) PutFindingsFindingID

func (s *ServerImpl) PutFindingsFindingID(ctx echo.Context, findingID models.FindingID) error

func (*ServerImpl) PutScanConfigsScanConfigID

func (s *ServerImpl) PutScanConfigsScanConfigID(ctx echo.Context, scanConfigID models.ScanConfigID, params models.PutScanConfigsScanConfigIDParams) error

func (*ServerImpl) PutScanResultsScanResultID

func (s *ServerImpl) PutScanResultsScanResultID(ctx echo.Context, scanResultID models.ScanResultID, params models.PutScanResultsScanResultIDParams) error

nolint:cyclop

func (*ServerImpl) PutScansScanID

func (s *ServerImpl) PutScansScanID(ctx echo.Context, scanID models.ScanID, params models.PutScansScanIDParams) error

func (*ServerImpl) PutTargetsTargetID

func (s *ServerImpl) PutTargetsTargetID(ctx echo.Context, targetID models.TargetID, params models.PutTargetsTargetIDParams) error