client

Documentation

Index

• func PreFetch(ctx context.Context, c DependencyClient, ...)
• type DependencyClient
• type DepsDevClient
  • func NewDepsDevClient(addr string) (*DepsDevClient, error)
  • func (d *DepsDevClient) AddRegistries(_ []Registry) error
  • func (d *DepsDevClient) LoadCache(path string) error
  • func (d *DepsDevClient) WriteCache(path string) error
• type MavenRegistryClient
  • func NewMavenRegistryClient(registry string) (*MavenRegistryClient, error)
  • func (c *MavenRegistryClient) AddRegistries(registries []Registry) error
  • func (c *MavenRegistryClient) LoadCache(path string) error
  • func (c *MavenRegistryClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)
  • func (c *MavenRegistryClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)
  • func (c *MavenRegistryClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)
  • func (c *MavenRegistryClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)
  • func (c *MavenRegistryClient) WriteCache(path string) error
• type NpmRegistryClient
  • func NewNpmRegistryClient(workdir string) (*NpmRegistryClient, error)
  • func (c *NpmRegistryClient) AddRegistries(_ []Registry) error
  • func (c *NpmRegistryClient) LoadCache(path string) error
  • func (c *NpmRegistryClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)
  • func (c *NpmRegistryClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)
  • func (c *NpmRegistryClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)
  • func (c *NpmRegistryClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)
  • func (c *NpmRegistryClient) WriteCache(path string) error
• type OSVClient
  • func NewOSVClient() *OSVClient
  • func (c *OSVClient) FindVulns(g *resolve.Graph) ([]models.Vulnerabilities, error)
• type OSVOfflineClient
  • func NewOSVOfflineClient(r reporter.Reporter, system resolve.System, downloadDBs bool, ...) (*OSVOfflineClient, error)
  • func (c *OSVOfflineClient) FindVulns(g *resolve.Graph) ([]models.Vulnerabilities, error)
• type OverrideClient
  • func NewOverrideClient(c DependencyClient) *OverrideClient
  • func (c *OverrideClient) AddVersion(v resolve.Version, deps []resolve.RequirementVersion)
  • func (c *OverrideClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)
  • func (c *OverrideClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)
  • func (c *OverrideClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)
  • func (c *OverrideClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)
• type Registry
• type ResolutionClient
• type VulnerabilityClient

Functions

func PreFetch

func PreFetch(ctx context.Context, c DependencyClient, requirements []resolve.RequirementVersion, manifestPath string)

PreFetch loads cache, then makes and caches likely queries needed for resolving a package with a list of requirements

Types

type DependencyClient

type DependencyClient interface {
	resolve.Client
	// WriteCache writes a manifest-specific resolution cache.
	WriteCache(filepath string) error
	// LoadCache loads a manifest-specific resolution cache.
	LoadCache(filepath string) error
	// AddRegistries adds the specified registries to fetch data.
	AddRegistries(registries []Registry) error
}

type DepsDevClient

type DepsDevClient struct {
	resolve.APIClient
	// contains filtered or unexported fields
}

DepsDevClient is a ResolutionClient wrapping the official resolve.APIClient

func NewDepsDevClient

func NewDepsDevClient(addr string) (*DepsDevClient, error)

func (*DepsDevClient) AddRegistries

func (d *DepsDevClient) AddRegistries(_ []Registry) error

func (*DepsDevClient) LoadCache

func (d *DepsDevClient) LoadCache(path string) error

func (*DepsDevClient) WriteCache

func (d *DepsDevClient) WriteCache(path string) error

type MavenRegistryClient

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

func NewMavenRegistryClient

func NewMavenRegistryClient(registry string) (*MavenRegistryClient, error)

func (*MavenRegistryClient) AddRegistries

func (c *MavenRegistryClient) AddRegistries(registries []Registry) error

func (*MavenRegistryClient) LoadCache

func (c *MavenRegistryClient) LoadCache(path string) error

func (*MavenRegistryClient) MatchingVersions

func (c *MavenRegistryClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)

func (*MavenRegistryClient) Requirements

func (c *MavenRegistryClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)

func (*MavenRegistryClient) Version

func (c *MavenRegistryClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)

func (*MavenRegistryClient) Versions

func (c *MavenRegistryClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)

TODO: we should also include versions not listed in the metadata file There exist versions in the repository but not listed in the metada file, for example version 20030203.000550 of package commons-io:commons-io https://repo1.maven.org/maven2/commons-io/commons-io/20030203.000550/. A package may depend on such version if a soft requirement of this version is declared. We need to find out if there are such versions and include them in the returned versions.

func (*MavenRegistryClient) WriteCache

func (c *MavenRegistryClient) WriteCache(path string) error

type NpmRegistryClient

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

func NewNpmRegistryClient

func NewNpmRegistryClient(workdir string) (*NpmRegistryClient, error)

func (*NpmRegistryClient) AddRegistries

func (c *NpmRegistryClient) AddRegistries(_ []Registry) error

func (*NpmRegistryClient) LoadCache

func (c *NpmRegistryClient) LoadCache(path string) error

func (*NpmRegistryClient) MatchingVersions

func (c *NpmRegistryClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)

func (*NpmRegistryClient) Requirements

func (c *NpmRegistryClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)

func (*NpmRegistryClient) Version

func (c *NpmRegistryClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)

func (*NpmRegistryClient) Versions

func (c *NpmRegistryClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)

func (*NpmRegistryClient) WriteCache

func (c *NpmRegistryClient) WriteCache(path string) error

type OSVClient

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

func NewOSVClient

func NewOSVClient() *OSVClient

func (*OSVClient) FindVulns

func (c *OSVClient) FindVulns(g *resolve.Graph) ([]models.Vulnerabilities, error)

type OSVOfflineClient

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

func NewOSVOfflineClient

func NewOSVOfflineClient(r reporter.Reporter, system resolve.System, downloadDBs bool, localDBPath string) (*OSVOfflineClient, error)

func (*OSVOfflineClient) FindVulns

func (c *OSVOfflineClient) FindVulns(g *resolve.Graph) ([]models.Vulnerabilities, error)

type OverrideClient

type OverrideClient struct {
	DependencyClient
	// contains filtered or unexported fields
}

OverrideClient wraps a DependencyClient, allowing for custom packages & versions to be added

func NewOverrideClient

func NewOverrideClient(c DependencyClient) *OverrideClient

func (*OverrideClient) AddVersion

func (c *OverrideClient) AddVersion(v resolve.Version, deps []resolve.RequirementVersion)

func (*OverrideClient) MatchingVersions

func (c *OverrideClient) MatchingVersions(ctx context.Context, vk resolve.VersionKey) ([]resolve.Version, error)

func (*OverrideClient) Requirements

func (c *OverrideClient) Requirements(ctx context.Context, vk resolve.VersionKey) ([]resolve.RequirementVersion, error)

func (*OverrideClient) Version

func (c *OverrideClient) Version(ctx context.Context, vk resolve.VersionKey) (resolve.Version, error)

func (*OverrideClient) Versions

func (c *OverrideClient) Versions(ctx context.Context, pk resolve.PackageKey) ([]resolve.Version, error)

type Registry

type Registry struct {
	URL string
}

type ResolutionClient

type ResolutionClient struct {
	DependencyClient
	VulnerabilityClient
}

type VulnerabilityClient

type VulnerabilityClient interface {
	// FindVulns finds the vulnerabilities affecting each of Nodes in the graph.
	// The returned Vulnerabilities[i] corresponds to the vulnerabilities in g.Nodes[i].
	FindVulns(g *resolve.Graph) ([]models.Vulnerabilities, error)
}