rhel

Documentation

Index

• Constants
• func NewEcosystem(ctx context.Context) *indexer.Ecosystem
• func NormalizeSeverity(severity string) claircore.Severity
• type Coalescer
  • func NewCoalescer() *Coalescer
  • func (c *Coalescer) Coalesce(ctx context.Context, artifacts []*indexer.LayerArtifacts) (*claircore.IndexReport, error)
• type DistributionScanner
  • func (*DistributionScanner) Kind() string
  • func (*DistributionScanner) Name() string
  • func (ds *DistributionScanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)
  • func (*DistributionScanner) Version() string
• type Factory
  • func NewFactory(ctx context.Context, manifest string, opts ...FactoryOption) (*Factory, error)
  • func (f *Factory) Configure(ctx context.Context, cfg driver.ConfigUnmarshaler, c *http.Client) error
  • func (f *Factory) UpdaterSet(ctx context.Context) (driver.UpdaterSet, error)
• type FactoryConfig
• type FactoryOption
  • func FactoryWithClient(h *http.Client) FactoryOption
  • func FactoryWithUpdaterOptions(opts ...Option) FactoryOption
• type Matcher
  • func (*Matcher) Filter(record *claircore.IndexRecord) bool
  • func (*Matcher) Name() string
  • func (*Matcher) Query() []driver.MatchConstraint
  • func (m *Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, ...) (bool, error)
• type Option
  • func WithClient(c *http.Client) Option
  • func WithName(n string) Option
  • func WithURL(uri, compression string) Option
• type Release
• type RepoScannerConfig
• type RepositoryScanner
  • func NewRepositoryScanner(ctx context.Context, c *http.Client, cs2cpeURL string) *RepositoryScanner
  • func (r *RepositoryScanner) Configure(ctx context.Context, f indexer.ConfigDeserializer, c *http.Client) error
  • func (*RepositoryScanner) Kind() string
  • func (*RepositoryScanner) Name() string
  • func (r *RepositoryScanner) Scan(ctx context.Context, l *claircore.Layer) (repositories []*claircore.Repository, err error)
  • func (*RepositoryScanner) Version() string
• type Updater
  • func NewUpdater(v Release, opt ...Option) (*Updater, error)
  • func (u *Updater) Name() string
  • func (u *Updater) Parse(ctx context.Context, r io.ReadCloser) ([]*claircore.Vulnerability, error)
• Bugs

Constants

const (
	None      = "None"
	Low       = "Low"
	Moderate  = "Moderate"
	Important = "Important"
	Critical  = "Critical"
)

const DefaultContainerAPI = "https://catalog.redhat.com/api/containers/"

DefaultContainerAPI is a default Red Hat's container API URL

const DefaultManifest = `https://access.redhat.com/security/data/oval/v2/PULP_MANIFEST`

DefaultManifest is the url for the Red Hat OVAL pulp repository.

const DefaultRepo2CPEMappingURL = "https://access.redhat.com/security/data/metrics/repository-to-cpe.json"

DefaultRepo2CPEMappingURL is default URL with a mapping file provided by Red Hat

const RedHatRepositoryKey = "rhel-cpe-repository"

RedHatRepositoryKey is a key of Red Hat's CPE based repository

Functions

func NewEcosystem

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

NewEcosystem provides the set of scanners and coalescers for the rhel ecosystem

func NormalizeSeverity

func NormalizeSeverity(severity string) claircore.Severity

Types

type Coalescer

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

Coalescer takes individual layer artifacts and coalesces them to form the final image's package results

func NewCoalescer

func NewCoalescer() *Coalescer

NewCoalescer is a constructor for a Coalescer

func (*Coalescer) Coalesce

func (c *Coalescer) Coalesce(ctx context.Context, artifacts []*indexer.LayerArtifacts) (*claircore.IndexReport, error)

Coalesce coalesces artifacts found in layers and creates a final IndexReport with the final package details found in the image. This method blocks and when its finished the c.ir field will hold the final IndexReport

type DistributionScanner

type DistributionScanner struct{}

DistributionScanner attempts to discover if a layer displays characteristics of a RHEL distribution

func (*DistributionScanner) Kind

func (*DistributionScanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*DistributionScanner) Name

func (*DistributionScanner) Name() string

Name implements scanner.VersionedScanner.

func (*DistributionScanner) Scan

func (ds *DistributionScanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)

Scan will inspect the layer for an os-release or redhat-release file and perform a regex match for keywords indicating the associated RHEL release

If neither file is found a (nil,nil) is returned. If the files are found but all regexp fail to match an empty slice is returned.

func (*DistributionScanner) Version

func (*DistributionScanner) Version() string

Version implements scanner.VersionedScanner.

type Factory

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

Factory contains the configuration for fetching and parsing a pulp manifest.

func NewFactory

func NewFactory(ctx context.Context, manifest string, opts ...FactoryOption) (*Factory, error)

NewFactory creates a Factory making updaters based on the contents of the provided pulp manifest.

func (*Factory) Configure

func (f *Factory) Configure(ctx context.Context, cfg driver.ConfigUnmarshaler, c *http.Client) error

func (*Factory) UpdaterSet

func (f *Factory) UpdaterSet(ctx context.Context) (driver.UpdaterSet, error)

UpdaterSet implements driver.UpdaterSetFactory.

type FactoryConfig

type FactoryConfig struct {
	URL string `json:"url" yaml:"url"`
}

FactoryConfig is the configuration accepted by the rhel updaters.

By convention, this should be in a map called "rhel".

type FactoryOption

type FactoryOption func(*Factory) error

A FactoryOption is used with New to configure a Factory.

func FactoryWithClient

func FactoryWithClient(h *http.Client) FactoryOption

FactoryWithClient sets the http.Client used for fetching the pulp manifest.

func FactoryWithUpdaterOptions

func FactoryWithUpdaterOptions(opts ...Option) FactoryOption

FactoryWithUpdaterOptions provides Options down into created Updaters.

type Matcher

type Matcher struct {
}

Matcher implements driver.Matcher.

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 (m *Matcher) Vulnerable(ctx context.Context, record *claircore.IndexRecord, vuln *claircore.Vulnerability) (bool, error)

Vulnerable implements driver.Matcher.

type Option

type Option func(*Updater) error

Option is a type to configure an Updater.

func WithClient

func WithClient(c *http.Client) Option

WithClient sets an http.Client for use with an Updater.

If this Option is not supplied, http.DefaultClient will be used.

func WithName

func WithName(n string) Option

func WithURL

func WithURL(uri, compression string) Option

WithURL overrides the default URL to fetch an OVAL database.

type Release

type Release int

const (
	RHEL3 Release = 3
	RHEL4 Release = 4
	RHEL5 Release = 5
	RHEL6 Release = 6
	RHEL7 Release = 7
	RHEL8 Release = 8
)

type RepoScannerConfig

type RepoScannerConfig struct {
	Timeout             time.Duration `json:"timeout" yaml:"timeout"`
	API                 string        `json:"api" yaml:"api"`
	Repo2CPEMappingURL  string        `json:"repo2cpe_mapping_url" yaml:"repo2cpe_mapping_url"`
	Repo2CPEMappingFile string        `json:"repo2cpe_mapping_file" yaml:"repo2cpe_mapping_file"`
}

RepoScannerConfig is the struct that will be passed to (*RepositoryScanner).Configure's ConfigDeserializer argument.

type RepositoryScanner

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

RepositoryScanner implements Red Hat repositories

func NewRepositoryScanner

func NewRepositoryScanner(ctx context.Context, c *http.Client, cs2cpeURL string) *RepositoryScanner

NewRepositoryScanner create new Repo scanner struct and initialize mapping updater

func (*RepositoryScanner) Configure

func (r *RepositoryScanner) Configure(ctx context.Context, f indexer.ConfigDeserializer, c *http.Client) error

Configure implements the RPCScanner interface.

func (*RepositoryScanner) Kind

func (*RepositoryScanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*RepositoryScanner) Name

func (*RepositoryScanner) Name() string

Name implements scanner.Name.

func (*RepositoryScanner) Scan

func (r *RepositoryScanner) Scan(ctx context.Context, l *claircore.Layer) (repositories []*claircore.Repository, err error)

Scan gets Red Hat repositories information.

func (*RepositoryScanner) Version

func (*RepositoryScanner) Version() string

Version implements scanner.VersionedScanner.

type Updater

type Updater struct {
	ovalutil.Fetcher // fetch method promoted via embed
	// contains filtered or unexported fields
}

Updater fetches and parses RHEL-flavored OVAL databases.

func NewUpdater

func NewUpdater(v Release, opt ...Option) (*Updater, error)

NewUpdater returns an Updater.

func (*Updater) Name

func (u *Updater) Name() string

Name satisifies the driver.Updater interface.

func (*Updater) Parse

func (u *Updater) Parse(ctx context.Context, r io.ReadCloser) ([]*claircore.Vulnerability, error)

Notes

Bugs

• The semantics of the internal filesByRegexp function may be surprising:

  Paths have Clean called on them, but may still be absolute.

  Symlinks are not considered.

  Paths are considered as a string, with no special treatment of separators.