Documentation
¶
Index ¶
- Variables
- func ValidateFinding(result *Finding) (err error)
- func ValidateFindingCollection(result FindingCollection) (err error)
- func ValidateFindingCollectionView(result FindingCollectionView) (err error)
- func ValidateFindingView(result *FindingView) (err error)
- func ValidateIssueView(result *IssueView) (err error)
- func ValidateResourceGroupView(result *ResourceGroupView) (err error)
- func ValidateSourcewithnotargetView(result *SourcewithnotargetView) (err error)
- func ValidateTarget(result *Target) (err error)
- func ValidateTargetCollection(result TargetCollection) (err error)
- func ValidateTargetCollectionView(result TargetCollectionView) (err error)
- func ValidateTargetSummaryCollection(result TargetSummaryCollection) (err error)
- func ValidateTargetSummaryCollectionView(result TargetSummaryCollectionView) (err error)
- func ValidateTargetSummaryView(result *TargetSummaryView) (err error)
- func ValidateTargetView(result *TargetView) (err error)
- type Finding
- type FindingCollection
- type FindingCollectionView
- type FindingView
- type IssueView
- type ResourceGroupView
- type SourcewithnotargetView
- type Target
- type TargetCollection
- type TargetCollectionView
- type TargetSummaryCollection
- type TargetSummaryCollectionView
- type TargetSummaryView
- type TargetView
Constants ¶
This section is empty.
Variables ¶
var ( // TargetCollectionMap is a map indexing the attribute names of // TargetCollection by view name. TargetCollectionMap = map[string][]string{ "default": { "id", "identifier", "tags", }, } // TargetSummaryCollectionMap is a map indexing the attribute names of // TargetSummaryCollection by view name. TargetSummaryCollectionMap = map[string][]string{ "default": { "target_id", "identifier", "findings_count", "issues_count", "max_score", }, } // TargetMap is a map indexing the attribute names of Target by view name. TargetMap = map[string][]string{ "default": { "id", "identifier", "tags", }, } // FindingCollectionMap is a map indexing the attribute names of // FindingCollection by view name. FindingCollectionMap = map[string][]string{ "default": { "id", "issue", "target", "source", "details", "impact_details", "status", "score", "resources", }, } // FindingMap is a map indexing the attribute names of Finding by view name. FindingMap = map[string][]string{ "default": { "id", "issue", "target", "source", "details", "impact_details", "status", "score", "resources", }, } // TargetSummaryMap is a map indexing the attribute names of TargetSummary by // view name. TargetSummaryMap = map[string][]string{ "default": { "target_id", "identifier", "findings_count", "issues_count", "max_score", }, } // IssueMap is a map indexing the attribute names of Issue by view name. IssueMap = map[string][]string{ "default": { "id", "summary", "cwe_id", "description", "recommendations", "reference_links", "labels", }, } // SourcewithnotargetMap is a map indexing the attribute names of // Sourcewithnotarget by view name. SourcewithnotargetMap = map[string][]string{ "default": { "id", "name", "component", "instance", "options", "time", }, } // ResourceGroupMap is a map indexing the attribute names of ResourceGroup by // view name. ResourceGroupMap = map[string][]string{ "default": { "name", "attributes", "resources", }, } )
Functions ¶
func ValidateFinding ¶
ValidateFinding runs the validations defined on the viewed result type Finding.
func ValidateFindingCollection ¶
func ValidateFindingCollection(result FindingCollection) (err error)
ValidateFindingCollection runs the validations defined on the viewed result type FindingCollection.
func ValidateFindingCollectionView ¶
func ValidateFindingCollectionView(result FindingCollectionView) (err error)
ValidateFindingCollectionView runs the validations defined on FindingCollectionView using the "default" view.
func ValidateFindingView ¶
func ValidateFindingView(result *FindingView) (err error)
ValidateFindingView runs the validations defined on FindingView using the "default" view.
func ValidateIssueView ¶
ValidateIssueView runs the validations defined on IssueView using the "default" view.
func ValidateResourceGroupView ¶
func ValidateResourceGroupView(result *ResourceGroupView) (err error)
ValidateResourceGroupView runs the validations defined on ResourceGroupView using the "default" view.
func ValidateSourcewithnotargetView ¶
func ValidateSourcewithnotargetView(result *SourcewithnotargetView) (err error)
ValidateSourcewithnotargetView runs the validations defined on SourcewithnotargetView using the "default" view.
func ValidateTarget ¶
ValidateTarget runs the validations defined on the viewed result type Target.
func ValidateTargetCollection ¶
func ValidateTargetCollection(result TargetCollection) (err error)
ValidateTargetCollection runs the validations defined on the viewed result type TargetCollection.
func ValidateTargetCollectionView ¶
func ValidateTargetCollectionView(result TargetCollectionView) (err error)
ValidateTargetCollectionView runs the validations defined on TargetCollectionView using the "default" view.
func ValidateTargetSummaryCollection ¶
func ValidateTargetSummaryCollection(result TargetSummaryCollection) (err error)
ValidateTargetSummaryCollection runs the validations defined on the viewed result type TargetSummaryCollection.
func ValidateTargetSummaryCollectionView ¶
func ValidateTargetSummaryCollectionView(result TargetSummaryCollectionView) (err error)
ValidateTargetSummaryCollectionView runs the validations defined on TargetSummaryCollectionView using the "default" view.
func ValidateTargetSummaryView ¶
func ValidateTargetSummaryView(result *TargetSummaryView) (err error)
ValidateTargetSummaryView runs the validations defined on TargetSummaryView using the "default" view.
func ValidateTargetView ¶
func ValidateTargetView(result *TargetView) (err error)
ValidateTargetView runs the validations defined on TargetView using the "default" view.
Types ¶
type Finding ¶
type Finding struct {
// Type to project
Projected *FindingView
// View to render
View string
}
Finding is the viewed result type that is projected based on a view.
type FindingCollection ¶
type FindingCollection struct {
// Type to project
Projected FindingCollectionView
// View to render
View string
}
FindingCollection is the viewed result type that is projected based on a view.
type FindingCollectionView ¶
type FindingCollectionView []*FindingView
FindingCollectionView is a type that runs validations on a projected type.
type FindingView ¶
type FindingView struct {
// Finding ID
ID *string
// Issue
Issue *IssueView
// Target
Target *TargetView
// Source
Source *SourcewithnotargetView
// Finding details
Details *string
// Finding impact details
ImpactDetails *string
// Finding status. Can be 'OPEN' or 'FIXED'.
Status *string
// Finding severity score
Score *float32
// Other resources associated with the finding
Resources []*ResourceGroupView
}
FindingView is a type that runs validations on a projected type.
type IssueView ¶
type IssueView struct {
// Issue ID
ID *string
// Issue summary
Summary *string
// Common Weakness Enumeration ID
CweID *int
// Issue description
Description *string
// Recommendations to fix the issue
Recommendations []string
// Documentation reference for the issue
ReferenceLinks []string
// Labels associated with the issue
Labels []string
}
IssueView is a type that runs validations on a projected type.
type ResourceGroupView ¶
type ResourceGroupView struct {
// Name of the resource group
Name *string
// Column names of the resource group in the order that should be rendered
Attributes []string
// List containing the resource rows as hashmap
Resources []map[string]string
}
ResourceGroupView is a type that runs validations on a projected type.
type SourcewithnotargetView ¶
type SourcewithnotargetView struct {
// Source ID
ID *string
// Source name
Name *string
// Source component
Component *string
// Source instance
Instance *string
// Source options
Options *string
// Time on which the source scanned the target
Time *string
}
SourcewithnotargetView is a type that runs validations on a projected type.
type Target ¶
type Target struct {
// Type to project
Projected *TargetView
// View to render
View string
}
Target is the viewed result type that is projected based on a view.
type TargetCollection ¶
type TargetCollection struct {
// Type to project
Projected TargetCollectionView
// View to render
View string
}
TargetCollection is the viewed result type that is projected based on a view.
type TargetCollectionView ¶
type TargetCollectionView []*TargetView
TargetCollectionView is a type that runs validations on a projected type.
type TargetSummaryCollection ¶
type TargetSummaryCollection struct {
// Type to project
Projected TargetSummaryCollectionView
// View to render
View string
}
TargetSummaryCollection is the viewed result type that is projected based on a view.
type TargetSummaryCollectionView ¶
type TargetSummaryCollectionView []*TargetSummaryView
TargetSummaryCollectionView is a type that runs validations on a projected type.
type TargetSummaryView ¶
type TargetSummaryView struct {
// Target ID
TargetID *string
// Target identifier
Identifier *string
// Number of findings for target
FindingsCount *int
// Number of issues for target
IssuesCount *int
// Max score for target
MaxScore *float32
}
TargetSummaryView is a type that runs validations on a projected type.
type TargetView ¶
type TargetView struct {
// Target ID
ID *string
// Target identifier
Identifier *string
// List of tags associated with target
Tags []string
}
TargetView is a type that runs validations on a projected type.
Source Files