grafeas

Documentation

Index

• Constants
• func ValidateConfig(config kritisv1beta1.GrafeasConfigSpec) error
• type CertConfig
  • func LoadConfig(fileName string) (*CertConfig, error)
• type Client
  • func New(config kritisv1beta1.GrafeasConfigSpec, certs *CertConfig) (*Client, error)
  • func (c Client) AttestationNote(aa *kritisv1beta1.AttestationAuthority) (*grafeas.Note, error)
  • func (c Client) Attestations(containerImage string, aa *kritisv1beta1.AttestationAuthority) ([]metadata.RawAttestation, error)
  • func (c Client) Close()
  • func (c Client) CreateAttestationNote(aa *kritisv1beta1.AttestationAuthority) (*grafeas.Note, error)
  • func (c Client) CreateAttestationOccurrence(noteName string, containerImage string, ...) (*grafeas.Occurrence, error)
  • func (c Client) Vulnerabilities(containerImage string) ([]metadata.Vulnerability, error)

Constants

const (
	PkgVulnerability     = "PACKAGE_VULNERABILITY"
	AttestationAuthority = "ATTESTATION_AUTHORITY"
	DefaultProject       = "kritis" // DefaultProject is the default project name, only single project is supported
)

Functions

func ValidateConfig

func ValidateConfig(config kritisv1beta1.GrafeasConfigSpec) error

ValidateConfig checks whether the specified configuration is valid

Types

type CertConfig

type CertConfig struct {
	CertFile string `yaml:"certfile"` // A PEM encoded certificate file
	KeyFile  string `yaml:"keyfile"`  // A PEM encoded private key file
	CAFile   string `yaml:"cafile"`   // A PEM encoded CA's certificate file
}

CertConfig is the Grafeas certificates configuration.

func LoadConfig

func LoadConfig(fileName string) (*CertConfig, error)

LoadConfig creates a config from a YAML-file. If fileName is an empty string a default config will be returned.

type Client

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

Client implements the ReadWriteClient and ReadOnlyClient interfaces using grafeas API.

func New

func New(config kritisv1beta1.GrafeasConfigSpec, certs *CertConfig) (*Client, error)

TODO: separate constructor methods for r/w and r/o clients

func (Client) AttestationNote

func (c Client) AttestationNote(aa *kritisv1beta1.AttestationAuthority) (*grafeas.Note, error)

AttestationNote returns a note if it exists for given AttestationAuthority

func (Client) Attestations

func (c Client) Attestations(containerImage string, aa *kritisv1beta1.AttestationAuthority) ([]metadata.RawAttestation, error)

Attestations gets Attestations for a specified image and a specified AttestationAuthority.

func (Client) Close

func (c Client) Close()

Close closes client connections

func (Client) CreateAttestationNote

func (c Client) CreateAttestationNote(aa *kritisv1beta1.AttestationAuthority) (*grafeas.Note, error)

CreateAttestationNote creates an attestation note from AttestationAuthority

func (Client) CreateAttestationOccurrence

func (c Client) CreateAttestationOccurrence(noteName string, containerImage string, pgpSigningKey *secrets.PGPSigningSecret, proj string) (*grafeas.Occurrence, error)

CreateAttestationOccurrence creates an Attestation occurrence for a given image, secret, and project.

func (Client) Vulnerabilities

func (c Client) Vulnerabilities(containerImage string) ([]metadata.Vulnerability, error)

Vulnerabilities gets Package Vulnerabilities Occurrences for a specified image.