securityscorecards

Documentation

Index

• type Client
  • func NewClient(httpClient *http.Client) Client
  • func (c *Client) GetResult(ctx context.Context, repoPath string) (*ScorecardResult, error)
• type Parser
  • func NewParser() Parser
  • func (p Parser) ParseFile(ctx context.Context, filename string) (ScorecardResult, error)
  • func (p Parser) ParseFiles(ctx context.Context, glob string, pw progress.Writer) ([]ScorecardResult, error)
• type ScorecardCheck
• type ScorecardRepo
• type ScorecardResult

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(httpClient *http.Client) Client

func (*Client) GetResult

func (c *Client) GetResult(ctx context.Context, repoPath string) (*ScorecardResult, error)

GetResult retrieves a ScorecardResult for a given repository.

`repoPath` should be the URL to a repository with no scheme in it, for instance `https://gitlab.com/gitlab-org/sbom/generator` would become `gitlab.com/gitlab-org/sbom/generator`

type Parser

type Parser struct{}

func NewParser

func NewParser() Parser

func (Parser) ParseFile

func (p Parser) ParseFile(ctx context.Context, filename string) (ScorecardResult, error)

func (Parser) ParseFiles

func (p Parser) ParseFiles(ctx context.Context, glob string, pw progress.Writer) ([]ScorecardResult, error)

type ScorecardCheck

type ScorecardCheck struct {
	Name  string `json:"name"`
	Score int    `json:"score"`
}

type ScorecardRepo

type ScorecardRepo struct {
	Name string `json:"name"`
}

type ScorecardResult

type ScorecardResult struct {
	Score  float32          `json:"score" yaml:"score"`
	Checks []ScorecardCheck `json:"checks" yaml:"checks"`
	Repo   ScorecardRepo    `json:"repo"`
}