advisory

Documentation

Index

• Constants
• func CombineTablesIntoAdvisoriesTable(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB, pw progress.Writer) error
• 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 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 CombineTablesIntoAdvisoriesTable

func CombineTablesIntoAdvisoriesTable(ctx context.Context, logger *slog.Logger, sqlDB *sql.DB, pw progress.Writer) error

CombineTablesIntoAdvisoriesTable migrates package advisories from different tables within dependency-management-data into the `advisories` table, for easier retrieval of data

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 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