audit

Documentation

Overview

Package audit inspects resolved project supply-chain metadata.

Index

• type Finding
• type Metadata
• type Options
• type Report
  • func Inspect(project *projectmodel.Project, opts Options) Report

Types

type Finding

type Finding struct {
	ID        string `json:"id"`
	Severity  string `json:"severity"`
	Certainty string `json:"certainty"`
	Message   string `json:"message"`
	Package   string `json:"package,omitempty"`
}

type Metadata

type Metadata struct {
	Offline   bool   `json:"offline"`
	Source    string `json:"source"`
	Timestamp string `json:"timestamp,omitempty"`
}

type Options

type Options struct {
	Offline   bool
	Source    string
	Timestamp time.Time
}

type Report

type Report struct {
	SchemaVersion int       `json:"schemaVersion"`
	Metadata      Metadata  `json:"metadata"`
	Disclaimer    string    `json:"disclaimer"`
	Findings      []Finding `json:"findings"`
}

func Inspect

func Inspect(project *projectmodel.Project, opts Options) Report