macapps

Documentation

Overview

Package macapps extracts applications data from Info.plist files of OS X devices.

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Config() Config
  • func (e 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) ToCPEs(i *extractor.Inventory) []string
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int
• type Metadata

Constants

const (
	// Name is the unique name of this extractor.
	Name = "os/macapps"
)

Types

type Config

type Config struct {
	// Stats is a stats collector for reporting metrics.
	Stats stats.Collector
	// MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If
	// `FileRequired` gets a bigger file, it will return false,
	MaxFileSizeBytes int64
}

Config is the configuration for the Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the MacApp Application extractor.

type Extractor

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

Extractor extracts Mac Apps from /Applications Directory.

func New

func New(cfg Config) *Extractor

New returns a Mac App extractor.

For most use cases, initialize with: ``` e := New(DefaultConfig()) ```

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Ecosystem

func (e 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 extracts packages from Info.plist files passed through the scan input.

func (Extractor) FileRequired

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

FileRequired returns true if the specified file matches the Info.plist file pattern.

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

func (e Extractor) ToCPEs(i *extractor.Inventory) []string

ToCPEs is not applicable as this extractor does not infer CPEs from the Inventory.

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.

type Metadata

type Metadata struct {
	CFBundleDisplayName        string
	CFBundleIdentifier         string
	CFBundleShortVersionString string
	CFBundleExecutable         string
	CFBundleName               string
	CFBundlePackageType        string
	CFBundleSignature          string
	CFBundleVersion            string
	KSProductID                string
	KSUpdateURL                string
}

Metadata is the metadata struct for information parsed from the Info.plist file of a Mac App.