writeup

package

v0.1.2 Latest Latest Go to latest Published: Jul 22, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

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

Repository

github.com/KKloudTarus/synapse-ce

Links

Open Source Insights

Documentation ¶

Overview ¶

Package writeup holds the built-in finding-writeup library: reusable, curated finding text + remediation an operator inserts when authoring a manual finding, so report prose is consistent. It is static reference data – pure, deterministic, no I/O – and carries no LLM in the path. The authored finding (with this text) is what later flows into the report.

Index ¶

type Writeup
- func Catalog() []Writeup
- func Get(id string) (Writeup, bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Writeup ¶

type Writeup struct {
	ID          string          `json:"id"`       // stable slug, e.g. "xss-stored"
	Title       string          `json:"title"`    // suggested finding title
	Category    string          `json:"category"` // grouping label, e.g. "Web"
	CWE         string          `json:"cwe"`      // e.g. "CWE-79"
	Severity    shared.Severity `json:"severity"` // suggested severity
	CVSSVector  string          `json:"cvssVector"`
	Description string          `json:"description"`
	Remediation string          `json:"remediation"`
	References  []string        `json:"references"`
}

Writeup is one reusable finding template.

func Catalog ¶

func Catalog() []Writeup

Catalog returns the built-in writeup library in a stable order. It builds a fresh slice on each call so callers cannot mutate the shared reference data.

func Get ¶

func Get(id string) (Writeup, bool)

Get returns the writeup with the given id, or ok=false if none matches.

Source Files ¶

View all Source files

writeup.go

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