xsc

Documentation

Index

• Constants
• func CreateAnalyticsEvent(product xscservices.ProductName, eventType xscservices.EventType, ...) *xscservices.XscAnalyticsGeneralEvent
• func CreateFinalizedEvent(multiScanId string, startTime time.Time, totalFindings int, err error) xscservices.XscAnalyticsGeneralEventFinalize
• func CreateXscService(xrayVersion string, serviceDetails *config.ServerDetails) (xsc.XscService, error)
• func GetConfigProfile(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, ...) (*services.ConfigProfile, error)
• func GetScanEvent(xrayVersion, xscVersion, multiScanId string, ...) (*xscservices.XscAnalyticsGeneralEvent, error)
• func IsReportLogErrorEventPossible(xscVersion string) bool
• func ReportError(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, ...) error
• func SendNewScanEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, ...) (multiScanId string, startTime time.Time)
• func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, ...)
• func SendScanEndedWithResults(serviceDetails *config.ServerDetails, ...)

Constants

const MinXscVersionForErrorReport = "1.7.7"

Functions

func CreateAnalyticsEvent

func CreateAnalyticsEvent(product xscservices.ProductName, eventType xscservices.EventType, serviceDetails *config.ServerDetails) *xscservices.XscAnalyticsGeneralEvent

func CreateFinalizedEvent

func CreateFinalizedEvent(multiScanId string, startTime time.Time, totalFindings int, err error) xscservices.XscAnalyticsGeneralEventFinalize

func CreateXscService

func CreateXscService(xrayVersion string, serviceDetails *config.ServerDetails) (xsc.XscService, error)

func GetConfigProfile

func GetConfigProfile(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, profileName string) (*services.ConfigProfile, error)

func GetScanEvent

func GetScanEvent(xrayVersion, xscVersion, multiScanId string, serviceDetails *config.ServerDetails) (*xscservices.XscAnalyticsGeneralEvent, error)

func IsReportLogErrorEventPossible

func IsReportLogErrorEventPossible(xscVersion string) bool

Determines if reporting the error is feasible.

func ReportError

func ReportError(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, errorToReport error, source string) error

Sends an error report when the Xsc service is enabled. Errors returned by this function typically do not disrupt the flow, as reporting errors is optional.

func SendNewScanEvent

func SendNewScanEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, event *xscservices.XscAnalyticsGeneralEvent) (multiScanId string, startTime time.Time)

func SendScanEndedEvent

func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, multiScanId string, startTime time.Time, totalFindings int, scanError error)

func SendScanEndedWithResults

func SendScanEndedWithResults(serviceDetails *config.ServerDetails, cmdResults *results.SecurityCommandResults)