issue

package

v2.29.0 Latest Latest Go to latest Published: Aug 25, 2026 License: Apache-2.0 Imports: 9 Imported by: 19

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/securego/gosec

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CodeSnippet(file *os.File, start int64, end int64) (string, error)
func GetCweByRule(id string) *cwe.Weakness
func GetLine(fobj *token.File, node ast.Node) string
type Issue
- func New(fobj *token.File, node ast.Node, ruleID, desc string, ...) *Issue
- func (i *Issue) FileLocation() string
- func (i *Issue) WithSuppressions(suppressions []SuppressionInfo) *Issue
type MetaData
- func NewMetaData(id, what string, severity, confidence Score) MetaData
- func (m MetaData) ID() string
type Score
- func (c Score) MarshalJSON() ([]byte, error)
- func (c Score) String() string
type SuppressionInfo

Constants ¶

View Source

const SnippetOffset = 1

SnippetOffset defines the number of lines captured before the beginning and after the end of a code snippet

Variables ¶

This section is empty.

Functions ¶

func CodeSnippet ¶

func CodeSnippet(file *os.File, start int64, end int64) (string, error)

CodeSnippet extracts a code snippet based on the ast reference

func GetCweByRule ¶

func GetCweByRule(id string) *cwe.Weakness

GetCweByRule retrieves a cwe weakness for a given RuleID

func GetLine ¶ added in v2.18.1

func GetLine(fobj *token.File, node ast.Node) string

GetLine returns the line number of a given ast.Node

Types ¶

type Issue ¶

type Issue struct {
	Severity     Score             `json:"severity"`          // issue severity (how problematic it is)
	Confidence   Score             `json:"confidence"`        // issue confidence (how sure we are we found it)
	Cwe          *cwe.Weakness     `json:"cwe"`               // Cwe associated with RuleID
	RuleID       string            `json:"rule_id"`           // Human readable explanation
	What         string            `json:"details"`           // Human readable explanation
	File         string            `json:"file"`              // File name we found it in
	Code         string            `json:"code"`              // Impacted code line
	Line         string            `json:"line"`              // Line number in file
	Col          string            `json:"column"`            // Column number in line
	NoSec        bool              `json:"nosec"`             // true if the issue is nosec
	Suppressions []SuppressionInfo `json:"suppressions"`      // Suppression info of the issue
	Autofix      string            `json:"autofix,omitempty"` // Proposed auto fix the issue
}

Issue is returned by a gosec rule if it discovers an issue with the scanned code.

func New ¶

func New(fobj *token.File, node ast.Node, ruleID, desc string, severity, confidence Score) *Issue

New creates a new Issue

func (*Issue) FileLocation ¶

func (i *Issue) FileLocation() string

FileLocation point out the file path and line number in file

func (*Issue) WithSuppressions ¶

func (i *Issue) WithSuppressions(suppressions []SuppressionInfo) *Issue

WithSuppressions set the suppressions of the issue

type MetaData ¶

type MetaData struct {
	RuleID     string
	Severity   Score
	Confidence Score
	What       string
}

MetaData is embedded in all gosec rules. The Severity, Confidence and What message will be passed through to reported issues.

func NewMetaData ¶ added in v2.23.0

func NewMetaData(id, what string, severity, confidence Score) MetaData

NewMetaData creates a new MetaData object

func (MetaData) ID ¶

func (m MetaData) ID() string

ID returns the rule ID. This satisfies part of the gosec.Rule interface when MetaData is embedded in a rule struct.

type Score ¶

type Score int

Score type used by severity and confidence values

const (
	// Low severity or confidence
	Low Score = iota
	// Medium severity or confidence
	Medium
	// High severity or confidence
	High
)

func (Score) MarshalJSON ¶

func (c Score) MarshalJSON() ([]byte, error)

MarshalJSON is used convert a Score object into a JSON representation

func (Score) String ¶

func (c Score) String() string

String converts a Score into a string

type SuppressionInfo ¶

type SuppressionInfo struct {
	Kind          string `json:"kind"`
	Justification string `json:"justification"`
}

SuppressionInfo object is to record the kind and the justification that used to suppress violations.

Source Files ¶

View all Source files

issue.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL