binary

Documentation

Overview

Package binary provides a concrete Cataloger implementations for surfacing possible packages based on signatures found within binary files.

Index

• func NewCataloger() pkg.Cataloger
• type Cataloger
  • func (c Cataloger) Catalog(resolver file.Resolver) ([]pkg.Package, []artifact.Relationship, error)
  • func (c Cataloger) Name() string

Functions

func NewCataloger

func NewCataloger() pkg.Cataloger

Types

type Cataloger

type Cataloger struct{}

Cataloger is the cataloger responsible for surfacing evidence of a very limited set of binary files, which have been identified by the classifiers. The Cataloger is _NOT_ a place to catalog any and every binary, but rather the specific set that has been curated to be important, predominantly related to toolchain- related runtimes like Python, Go, Java, or Node. Some exceptions can be made for widely-used binaries such as busybox.

func (Cataloger) Catalog

func (c Cataloger) Catalog(resolver file.Resolver) ([]pkg.Package, []artifact.Relationship, error)

Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing the catalog source.

func (Cataloger) Name

func (c Cataloger) Name() string

Name returns a string that uniquely describes the Cataloger