settings

type BOM ¶

type BOM struct {
	// Include specifies components declared to be present. Schema spelling of Identify.
	Include []BOMEntry `json:"include,omitempty"`
	// Identify specifies components that should be identified as declared dependencies
	Identify []BOMEntry `json:"identify,omitempty"`
	// Ignore specifies components that should be ignored/whitelisted in scan results
	Ignore []BOMEntry `json:"ignore,omitempty"`
	// Exclude specifies components to drop from matches. Schema spelling of Ignore.
	Exclude []BOMEntry `json:"exclude,omitempty"`
	// Remove specifies components that should be removed/blacklisted from scan results
	Remove []BOMEntry `json:"remove,omitempty"`
	// Replace specifies components that should be replaced with alternatives
	Replace []BOMEntry `json:"replace,omitempty"`
}

BOM represents the Bill of Materials section in the settings file. It contains lists of components to identify, ignore, or remove from scan results.

Two of the rules are spelled two ways, because the published scanoss.json schema and this client's own settings grew apart: the schema calls them "include" and "exclude", while this client declared "identify" and "ignore". Both spellings are read, and are folded together by IdentifyRules and IgnoreRules — which is what consumers should use rather than the fields.

func (b BOM) IdentifyRules() []BOMEntry

func (b BOM) IgnoreRules() []BOMEntry

type BOMEntry ¶

type BOMEntry struct {
	// PURL (Package URL) identifying the component. Supports glob patterns (e.g., pkg:npm/lodash@*)
	Purl string `json:"purl"`
	// Path optional file path pattern to scope this entry
	Path string `json:"path,omitempty"`
	// ReplaceWith specifies the PURL to replace with (only for Replace entries)
	ReplaceWith string `json:"replace_with,omitempty"`
}

BOMEntry represents a single BOM (Bill of Materials) entry that specifies how the scanner should handle a particular component.

type FileSnippet ¶ added in v0.8.1

type FileSnippet struct {
	// SkipHeaders skips license headers, comments and imports at the start of each file
	// when fingerprinting.
	SkipHeaders *bool `json:"skip_headers,omitempty"`
	// SkipHeadersLimit caps how many leading lines SkipHeaders may drop (0 = no cap).
	SkipHeadersLimit *int `json:"skip_headers_limit,omitempty"`
	// RankingThreshold drops matches whose component ranks worse than this. Rank is the
	// scanner's own ordering, lowest is strongest. Valid range -1..MaxRankingThreshold;
	// anything at or below 0 disables the filter.
	RankingThreshold *int `json:"ranking_threshold,omitempty"`
}

FileSnippet mirrors settings.file_snippet: the knobs that tune how files are fingerprinted and matched.

Only the ones this client acts on are declared. The rest of the section (min_snippet_hits, min_snippet_lines, ranking_enabled, honour_file_exts) tunes the matching engine, not the client, and this client does not forward scan settings to the server — so declaring them here would promise something nothing honors.

ranking_threshold is the exception that proves the rule: scanoss.py sends it to the server, which filters before reporting. Here it is applied to the result the batch scanner returns, which reports every candidate match with its rank — so the same setting reaches the same outcome without the server needing to know about it.

The fields are pointers because the schema's "unset" is a value, not an absence: skip_headers defaults to false, skip_headers_limit to 0 and ranking_threshold to 0, so a plain bool/int cannot say whether the settings file asked for that or said nothing at all. That difference is what decides whether the file overrides the command line.

type Settings ¶

type Settings struct {
	BOM BOM `json:"bom"`
	// Settings holds the input-filtering rules (the scanoss.json "settings"
	// section). Optional.
	Settings Tuning `json:"settings,omitempty"`
}

Settings represents the scanoss settings file structure.

func Load(path string) (*Settings, error)

func (s *Settings) HasBOM() bool

type SizeRule ¶

type SizeRule struct {
	Patterns []string `json:"patterns"`
	Min      int64    `json:"min"`
	Max      int64    `json:"max"`
}

SizeRule is one entry under settings.skip.sizes.<operation>: files matching any of Patterns are skipped when smaller than Min or larger than Max (0 disables a bound).

type Skip ¶

type Skip struct {
	Patterns SkipPatternsByOp `json:"patterns,omitempty"`
	Sizes    SkipSizesByOp    `json:"sizes,omitempty"`
}

Skip mirrors the settings.skip section of scanoss.json.

type SkipPatternsByOp ¶

type SkipPatternsByOp struct {
	Scanning       []string `json:"scanning,omitempty"`
	Fingerprinting []string `json:"fingerprinting,omitempty"`
	Dependencies   []string `json:"dependencies,omitempty"`
}

SkipPatternsByOp mirrors settings.skip.patterns: glob patterns per operation.

type SkipSizesByOp ¶

type SkipSizesByOp struct {
	Scanning       []SizeRule `json:"scanning,omitempty"`
	Fingerprinting []SizeRule `json:"fingerprinting,omitempty"`
	Dependencies   []SizeRule `json:"dependencies,omitempty"`
}

SkipSizesByOp mirrors settings.skip.sizes: size rules per operation.

type Tuning ¶

type Tuning struct {
	Skip        Skip        `json:"skip,omitempty"`
	FileSnippet FileSnippet `json:"file_snippet,omitempty"`
}

Tuning mirrors the top-level settings section of scanoss.json: the input-filtering skip rules applied during file collection, and the file_snippet fingerprinting knobs.

func (t Tuning) RankingThreshold() (value int, ok bool)

func (t Tuning) SkipHeaders() (value, ok bool)

func (t Tuning) SkipHeadersLimit() (value int, ok bool)

func (t Tuning) SkipPatterns(operation string) []string

func (t Tuning) SkipSizes(operation string) []SizeRule