provider

Documentation

Index

• Variables
• func IsAuthenticationError(err error) bool
• func IsInvalidTokenError(err error) bool
• func UseExternalBinary(providerOpts Options) bool
• type DockerSnykProviderOps
• type Ops
  • func WithAppVulns() Ops
  • func WithAuthConfig(authResolver func(*registry.IndexInfo) types.AuthConfig) Ops
  • func WithContext(ctx context.Context) Ops
  • func WithDependencyTree() Ops
  • func WithDockerFile(path string) Ops
  • func WithExperimental() Ops
  • func WithFailOn(failOn string) Ops
  • func WithGroupIssues() Ops
  • func WithJSON() Ops
  • func WithPath(path string) Ops
  • func WithSeverity(severity string) Ops
  • func WithStreams(out, err io.Writer) Ops
  • func WithoutBaseImageVulnerabilities() Ops
• type Options
  • func NewProvider(options ...Ops) (Options, error)
• type Provider
  • func NewDockerSnykProvider(cli command.Cli, defaultProvider Options) (Provider, error)
  • func NewSnykProvider(defaultProvider Options, snykOps ...SnykProviderOps) (Provider, error)
• type SnykProviderOps

Variables

var (
	ImageDigest = "unknown"
)

ImageDigest is the sha snyk/snyk:alpine image, set at build time

var (
	// SnykDesktopVersion is the version of the Snyk CLI Binary embedded with Docker Desktop
	SnykDesktopVersion = "unknown"
)

Functions

func IsAuthenticationError

func IsAuthenticationError(err error) bool

IsAuthenticationError check if the error type is an authentication error

func IsInvalidTokenError

func IsInvalidTokenError(err error) bool

IsInvalidTokenError check if the error type is an invalid token error

func UseExternalBinary

func UseExternalBinary(providerOpts Options) bool

UseExternalBinary return true if the provider path option is setup

Types

type DockerSnykProviderOps

type DockerSnykProviderOps func(provider *dockerSnykProvider) error

DockerSnykProviderOps function taking a pointer to a containerized Snyk Provider and returning an error if needed

type Ops

type Ops func(provider *Options) error

Ops defines options to setup a provider

func WithAppVulns

func WithAppVulns() Ops

WithAppVulns scans for applications vulnerabilities as well

func WithAuthConfig

func WithAuthConfig(authResolver func(*registry.IndexInfo) types.AuthConfig) Ops

WithAuthConfig update the Snyk provider with the auth configuration from Docker CLI

func WithContext

func WithContext(ctx context.Context) Ops

WithContext update the provider with a cancelable context

func WithDependencyTree

func WithDependencyTree() Ops

WithDependencyTree shows the dependency tree before scan results

func WithDockerFile

func WithDockerFile(path string) Ops

WithDockerFile improve result by providing a Dockerfile

func WithExperimental

func WithExperimental() Ops

WithExperimental allows running `--json` flag in combination of `--app-vulns`

func WithFailOn

func WithFailOn(failOn string) Ops

WithFailOn only fail when there are vulnerabilities that can be fixed

func WithGroupIssues

func WithGroupIssues() Ops

WithGroupIssues groups same issues in a single one when using --json flag

func WithJSON

func WithJSON() Ops

WithJSON set JSONFormat to display scan result in JSON

func WithPath

func WithPath(path string) Ops

WithPath update the provider binary with the path from the configuration

func WithSeverity

func WithSeverity(severity string) Ops

WithSeverity only reports vulnerabilities of the provided level or higher

func WithStreams

func WithStreams(out, err io.Writer) Ops

WithStreams sets the out and err streams to be used by commands

func WithoutBaseImageVulnerabilities

func WithoutBaseImageVulnerabilities() Ops

WithoutBaseImageVulnerabilities don't display the vulnerabilities from the base image

type Options

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

Options default options for all provider types

func NewProvider

func NewProvider(options ...Ops) (Options, error)

NewProvider returns default provider options setup with the give options

type Provider

type Provider interface {
	Authenticate(token string) error
	Scan(image string) error
	Version() (string, error)
}

Provider abstracts a scan provider

func NewDockerSnykProvider

func NewDockerSnykProvider(cli command.Cli, defaultProvider Options) (Provider, error)

NewDockerSnykProvider returns a containerized Snyk implementation of scan provider

func NewSnykProvider

func NewSnykProvider(defaultProvider Options, snykOps ...SnykProviderOps) (Provider, error)

NewSnykProvider returns a Snyk implementation of scan provider

type SnykProviderOps

type SnykProviderOps func(*snykProvider) error

SnykProviderOps function taking a pointer to a Snyk Provider and returning an error if needed