xray

Documentation

Index

• type XrayServicesManager
  • func New(config config.Config) (*XrayServicesManager, error)
  • func (sm *XrayServicesManager) AddBuildsToIndexing(buildNames []string) error
  • func (sm *XrayServicesManager) BuildScan(params services.XrayBuildParams, includeVulnerabilities bool) (scanResponse *services.BuildScanResponse, noFailBuildPolicy bool, err error)
  • func (sm *XrayServicesManager) Client() *jfroghttpclient.JfrogHttpClient
  • func (sm *XrayServicesManager) Config() config.Config
  • func (sm *XrayServicesManager) CreatePolicy(params utils.PolicyParams) error
  • func (sm *XrayServicesManager) CreateWatch(params utils.WatchParams) error
  • func (sm *XrayServicesManager) DeletePolicy(policyName string) error
  • func (sm *XrayServicesManager) DeleteReport(reportId string) error
  • func (sm *XrayServicesManager) DeleteWatch(watchName string) error
  • func (sm *XrayServicesManager) GenerateVulnerabilitiesReport(params services.ReportRequestParams) (resp *services.ReportResponse, err error)
  • func (sm *XrayServicesManager) GetPolicy(policyName string) (*utils.PolicyParams, error)
  • func (sm *XrayServicesManager) GetScanGraphResults(scanID string, includeVulnerabilities, includeLicenses bool) (*services.ScanResponse, error)
  • func (sm *XrayServicesManager) GetVersion() (string, error)
  • func (sm *XrayServicesManager) GetWatch(watchName string) (*utils.WatchParams, error)
  • func (sm *XrayServicesManager) ReportContent(params services.ReportContentRequestParams) (content *services.ReportContent, err error)
  • func (sm *XrayServicesManager) ReportDetails(reportId string) (details *services.ReportDetails, err error)
  • func (sm *XrayServicesManager) ScanGraph(params services.XrayGraphScanParams) (scanId string, err error)
  • func (sm *XrayServicesManager) UpdatePolicy(params utils.PolicyParams) error
  • func (sm *XrayServicesManager) UpdateWatch(params utils.WatchParams) error

Types

type XrayServicesManager

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

XrayServicesManager defines the http client and general configuration

func New

func New(config config.Config) (*XrayServicesManager, error)

New creates a service manager to interact with Xray

func (*XrayServicesManager) AddBuildsToIndexing

func (sm *XrayServicesManager) AddBuildsToIndexing(buildNames []string) error

AddBuildsToIndexing will add builds to Xray indexing configuration

func (*XrayServicesManager) BuildScan

func (sm *XrayServicesManager) BuildScan(params services.XrayBuildParams, includeVulnerabilities bool) (scanResponse *services.BuildScanResponse, noFailBuildPolicy bool, err error)

BuildScan scans a published build-info with Xray. 'scanResponse' - Xray scan output of the requested build scan. 'noFailBuildPolicy' - Indicates that the Xray API returned a "No Xray Fail build...." error

func (*XrayServicesManager) Client

func (sm *XrayServicesManager) Client() *jfroghttpclient.JfrogHttpClient

Client will return the http client

func (*XrayServicesManager) Config

func (sm *XrayServicesManager) Config() config.Config

func (*XrayServicesManager) CreatePolicy

func (sm *XrayServicesManager) CreatePolicy(params utils.PolicyParams) error

CreatePolicy will create a new Xray policy

func (*XrayServicesManager) CreateWatch

func (sm *XrayServicesManager) CreateWatch(params utils.WatchParams) error

CreateWatch will create a new Xray watch

func (*XrayServicesManager) DeletePolicy

func (sm *XrayServicesManager) DeletePolicy(policyName string) error

DeletePolicy will delete an existing policy by name It will error if no policy can be found by that name.

func (*XrayServicesManager) DeleteReport

func (sm *XrayServicesManager) DeleteReport(reportId string) error

DeleteReport deletes a Xray report

func (*XrayServicesManager) DeleteWatch

func (sm *XrayServicesManager) DeleteWatch(watchName string) error

DeleteWatch will delete an existing watch by name It will error if no watch can be found by that name.

func (*XrayServicesManager) GenerateVulnerabilitiesReport

func (sm *XrayServicesManager) GenerateVulnerabilitiesReport(params services.ReportRequestParams) (resp *services.ReportResponse, err error)

GenerateVulnerabilitiesReport returns a Xray report response of the requested report

func (*XrayServicesManager) GetPolicy

func (sm *XrayServicesManager) GetPolicy(policyName string) (*utils.PolicyParams, error)

GetPolicy retrieves the details about an Xray policy by name It will error if no policy can be found by that name.

func (*XrayServicesManager) GetScanGraphResults

func (sm *XrayServicesManager) GetScanGraphResults(scanID string, includeVulnerabilities, includeLicenses bool) (*services.ScanResponse, error)

GetScanGraphResults returns an Xray scan output of the requested graph scan. The scanId input should be received from ScanGraph request.

func (*XrayServicesManager) GetVersion

func (sm *XrayServicesManager) GetVersion() (string, error)

GetVersion will return the Xray version

func (*XrayServicesManager) GetWatch

func (sm *XrayServicesManager) GetWatch(watchName string) (*utils.WatchParams, error)

GetWatch retrieves the details about an Xray watch by name It will error if no watch can be found by that name.

func (*XrayServicesManager) ReportContent

func (sm *XrayServicesManager) ReportContent(params services.ReportContentRequestParams) (content *services.ReportContent, err error)

ReportContent returns a Xray report content response for the requested report

func (*XrayServicesManager) ReportDetails

func (sm *XrayServicesManager) ReportDetails(reportId string) (details *services.ReportDetails, err error)

ReportDetails returns a Xray details response for the requested report

func (*XrayServicesManager) ScanGraph

func (sm *XrayServicesManager) ScanGraph(params services.XrayGraphScanParams) (scanId string, err error)

ScanGraph will send Xray the given graph for scan Returns a string represents the scan ID.

func (*XrayServicesManager) UpdatePolicy

func (sm *XrayServicesManager) UpdatePolicy(params utils.PolicyParams) error

UpdatePolicy will update an existing Xray policy by name It will error if no policy can be found by that name.

func (*XrayServicesManager) UpdateWatch

func (sm *XrayServicesManager) UpdateWatch(params utils.WatchParams) error

UpdateWatch will update an existing Xray watch by name It will error if no watch can be found by that name.