github.com/devseccon/trivy@v0.47.1-0.20231123133102-bd902a0bd996/pkg/types/misconfiguration.go (about)

     1  package types
     2  
     3  import ftypes "github.com/devseccon/trivy/pkg/fanal/types"
     4  
     5  // DetectedMisconfiguration holds detected misconfigurations
     6  type DetectedMisconfiguration struct {
     7  	Type          string               `json:",omitempty"`
     8  	ID            string               `json:",omitempty"`
     9  	AVDID         string               `json:",omitempty"`
    10  	Title         string               `json:",omitempty"`
    11  	Description   string               `json:",omitempty"`
    12  	Message       string               `json:",omitempty"`
    13  	Namespace     string               `json:",omitempty"`
    14  	Query         string               `json:",omitempty"`
    15  	Resolution    string               `json:",omitempty"`
    16  	Severity      string               `json:",omitempty"`
    17  	PrimaryURL    string               `json:",omitempty"`
    18  	References    []string             `json:",omitempty"`
    19  	Status        MisconfStatus        `json:",omitempty"`
    20  	Layer         ftypes.Layer         `json:",omitempty"`
    21  	CauseMetadata ftypes.CauseMetadata `json:",omitempty"`
    22  
    23  	// For debugging
    24  	Traces []string `json:",omitempty"`
    25  }
    26  
    27  // MisconfStatus represents a status of misconfiguration
    28  type MisconfStatus string
    29  
    30  const (
    31  	// StatusPassed represents successful status
    32  	StatusPassed MisconfStatus = "PASS"
    33  
    34  	// StatusFailure represents failure status
    35  	StatusFailure MisconfStatus = "FAIL"
    36  
    37  	// StatusException Passed represents the status of exception
    38  	StatusException MisconfStatus = "EXCEPTION"
    39  )
    40  
    41  // GetID retrun misconfig ID
    42  func (mc *DetectedMisconfiguration) GetID() string {
    43  	return mc.AVDID
    44  }