advisory

Documentation

Index

• Constants
• func ReportAWS(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB) (table.Writer, error)
• func ReportPackages(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB, ...) (table.Writer, error)
• type Advisories
  • func (d *Advisories) AnonymiseData(ctx context.Context, sqlDB *sql.DB, orgs []string) (err error)
  • func (*Advisories) CreateTables(ctx context.Context, sqlDB *sql.DB) error
  • func (*Advisories) Name() string
• type Advisory
• type AdvisoryType
• type VersionMatchStrategy

Constants

const (
	AdvisoryTypeDeprecated   = "DEPRECATED"
	AdvisoryTypeUnmaintained = "UNMAINTAINED"
	AdvisoryTypeSecurity     = "SECURITY"
	AdvisoryTypePolicy       = "POLICY"
	AdvisoryTypeOther        = "OTHER"
)

const (
	VersionMatchStrategyAny              = "ANY"
	VersionMatchStrategyEquals           = "EQUALS"
	VersionMatchStrategyLessThan         = "LESS_THAN"
	VersionMatchStrategyLessOrEqualTo    = "LESS_EQUAL"
	VersionMatchStrategyGreaterThan      = "GREATER_THAN"
	VersionMatchStrategyGreaterOrEqualTo = "GREATER_EQUAL"
)

Functions

func ReportAWS

func ReportAWS(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB) (table.Writer, error)

func ReportPackages

func ReportPackages(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB, platform, org, repo, owner, advisoryType string, summaryOutput bool) (table.Writer, error)

Types

type Advisories

type Advisories struct{}

func (*Advisories) AnonymiseData

func (d *Advisories) AnonymiseData(ctx context.Context, sqlDB *sql.DB, orgs []string) (err error)

func (*Advisories) CreateTables

func (*Advisories) CreateTables(ctx context.Context, sqlDB *sql.DB) error

func (*Advisories) Name

func (*Advisories) Name() string

type Advisory

type Advisory struct {
	// PackagePattern contains a simple wildcard-aware pattern of packages that these advisories are for
	// For example:
	// `github.com/gorilla/*` would expect to match `github.com/gorilla/mux` and `github.com/gorilla/`
	// `git*.com/jamietanna/*` would expect to match `gitlab.com/jamietanna/test` and `github.com/jamietanna/not-test`
	PackagePattern string
	PackageManager string
	// Version contains the version that is expected to match. If nil, will always match
	Version *string
	// VersionMatchStrategy:
	//
	// VersionMatchStrategy defines the way that the version is expected to lexicographically match. If nil, will always match
	VersionMatchStrategy *VersionMatchStrategy
	AdvisoryType         AdvisoryType
	// Description describes why a given advisory is set on this package
	Description string
}

Advisory contains a package advisory, which allows flagging packages (for an optional set of version(s)) for arbitrary reasons

type AdvisoryType

type AdvisoryType = string

AdvisoryType is the type of package advisory that is present

type VersionMatchStrategy

type VersionMatchStrategy = string

VersionMatchStrategy defines how the Advisory.Version, if present, should be compared lexicographically with a CurrentVersion