homebrew

Documentation

Overview

Package homebrew extracts package information from OSX homebrew INSTALL_RECEIPT.json files.

Index

• type BrewPath
  • func SplitPath(path string) *BrewPath
• type Extractor
  • func (Extractor) Ecosystem(i *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int

Types

type BrewPath

type BrewPath struct {
	AppName    string
	AppVersion string
	AppFile    string
	AppExt     string
}

BrewPath struct holds homebrew package information from homebrew package path. ../${appClass}/${appName}/${version}/${appFile} e.g. ../Caskroom/firefox/1.1/firefox.wrapper.sh or ../Cellar/tree/1.1/INSTALL_RECEIPT.json

func SplitPath

func SplitPath(path string) *BrewPath

SplitPath takes the package path and splits it into its recognised struct components

type Extractor

type Extractor struct{}

Extractor extracts software details from a OSX Homebrew package path.

func (Extractor) Ecosystem

func (Extractor) Ecosystem(i *extractor.Inventory) string

Ecosystem returns no Ecosystem since the ecosystem is not known by OSV yet.

func (Extractor) Extract

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)

Extract parses the recognised Homebrew file path and returns information about the installed package.

func (Extractor) FileRequired

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the specified file path matches the homebrew path.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.