ruby

Documentation

Overview

Package ruby contains components for interrogating ruby packages in container layers.

Index

• Variables
• func NewCoalescer(_ context.Context) (indexer.Coalescer, error)
• func NewEcosystem(_ context.Context) *indexer.Ecosystem
• type Matcher
  • func (*Matcher) Filter(record *claircore.IndexRecord) bool
  • func (*Matcher) Name() string
  • func (*Matcher) Query() []driver.MatchConstraint
  • func (*Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, ...) (bool, error)
• type Scanner
  • func (Scanner) DefaultRepository(ctx context.Context) *claircore.Repository
  • func (*Scanner) Kind() string
  • func (*Scanner) Name() string
  • func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)
  • func (*Scanner) Version() string
• type Segment
• type Version
  • func NewVersion(version string) (Version, error)
  • func (v Version) Compare(other Version) int

Variables

var (
	Repository = claircore.Repository{
		Name: repository,
		URI:  "https://rubygems.org/gems/",
	}
)

Functions

func NewCoalescer

func NewCoalescer(_ context.Context) (indexer.Coalescer, error)

func NewEcosystem

func NewEcosystem(_ context.Context) *indexer.Ecosystem

NewEcosystem provides the set of scanners for the ruby ecosystem.

Types

type Matcher

type Matcher struct{}

Matcher attempts to correlate discovered ruby packages with reported vulnerabilities.

func (*Matcher) Filter

func (*Matcher) Filter(record *claircore.IndexRecord) bool

Filter implements driver.Matcher.

func (*Matcher) Name

func (*Matcher) Name() string

Name implements driver.Matcher.

func (*Matcher) Query

func (*Matcher) Query() []driver.MatchConstraint

Query implements driver.Matcher.

func (*Matcher) Vulnerable

func (*Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, vuln *claircore.Vulnerability) (bool, error)

Vulnerable implements driver.Matcher.

type Scanner

type Scanner struct{}

Scanner implements the scanner.PackageScanner interface.

It looks for files that seem like gems, and looks at the metadata recorded there. This type attempts to follow the specs documented here: https://guides.rubygems.org/specification-reference/.

The zero value is ready to use.

func (Scanner) DefaultRepository

func (Scanner) DefaultRepository(ctx context.Context) *claircore.Repository

DefaultRepository implements indexer.DefaultRepoScanner.

func (*Scanner) Kind

func (*Scanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*Scanner) Name

func (*Scanner) Name() string

Name implements scanner.VersionedScanner.

func (*Scanner) Scan

func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)

Scan attempts to find gems and record the package information there.

A return of (nil, nil) is expected if there's nothing found.

func (*Scanner) Version

func (*Scanner) Version() string

Version implements scanner.VersionedScanner.

type Segment

type Segment interface {
	Compare(other Segment) int
}

Segment is a part of a RubyGem version.

type Version

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

Version is a RubyGem version. This is based on the official implementation.

func NewVersion

func NewVersion(version string) (Version, error)

NewVersion creates a Version out of the given string.

func (Version) Compare

func (v Version) Compare(other Version) int

Compare returns an integer comparing this version, v, to other. The result will be 0 if v == other, -1 if v < other, and +1 if v > other.