registry

Documentation

Index

• Constants
• type ArtifactMetadata
• type ArtifactPushMetadata
• type ArtifactsPushStatus
• type Capabilities
  • func (r *Capabilities) Decode(w io.Reader) error
  • func (r *Capabilities) Encode(w io.Writer) error
  • func (r *Capabilities) String() string
• type ExtractionCapability
  • func (r *ExtractionCapability) Decode(w io.Reader) error
  • func (r *ExtractionCapability) Encode(w io.Writer) error
  • func (r *ExtractionCapability) String() string
• type Plugin
  • func (r *Plugin) Decode(w io.Reader) error
  • func (r *Plugin) Encode(w io.Writer) error
  • func (r *Plugin) String() string
• type Registry
  • func LoadRegistryFromFile(fname string) (*Registry, error)
  • func (r *Registry) Decode(w io.Reader) error
  • func (r *Registry) Encode(w io.Writer) error
  • func (r *Registry) String() string
  • func (r *Registry) Validate() error
• type RepositoryMetadata
• type SourcingCapability
  • func (r *SourcingCapability) Decode(w io.Reader) error
  • func (r *SourcingCapability) Encode(w io.Writer) error
  • func (r *SourcingCapability) String() string

Constants

const MaxPublicID = 1<<30 - 1 // 1073741823 is the public block upper limit

MaxPublicID represents the max allowed value for plublic plugin IDs, see https://github.com/falcosecurity/plugins/blob/main/docs/plugin-ids.md

Types

type ArtifactMetadata

type ArtifactMetadata struct {
	Digest string   `json:"digest"`
	Tags   []string `json:"tags"`
}

type ArtifactPushMetadata

type ArtifactPushMetadata struct {
	Repository RepositoryMetadata `json:"repository"`
	Artifact   ArtifactMetadata   `json:"artifact"`
}

ArtifactPushMetadata represents metadata of a push of an OCI Artifact to an OCI repository.

type ArtifactsPushStatus

type ArtifactsPushStatus []ArtifactPushMetadata

type Capabilities

type Capabilities struct {
	Sourcing   SourcingCapability   `yaml:"sourcing"`
	Extraction ExtractionCapability `yaml:"extraction"`
}

func (*Capabilities) Decode

func (r *Capabilities) Decode(w io.Reader) error

Decode fills the structure by reading from a io.Reader

func (*Capabilities) Encode

func (r *Capabilities) Encode(w io.Writer) error

Encode writes the content to a io.Writer

func (*Capabilities) String

func (r *Capabilities) String() string

String implements the fmt.Stringer interface

type ExtractionCapability

type ExtractionCapability struct {
	Supported bool     `yaml:"supported"`
	Sources   []string `yaml:"sources"`
}

func (*ExtractionCapability) Decode

func (r *ExtractionCapability) Decode(w io.Reader) error

Decode fills the structure by reading from a io.Reader

func (*ExtractionCapability) Encode

func (r *ExtractionCapability) Encode(w io.Writer) error

Encode writes the content to a io.Writer

func (*ExtractionCapability) String

func (r *ExtractionCapability) String() string

String implements the fmt.Stringer interface

type Plugin

type Plugin struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Authors     string `yaml:"authors"`
	Contact     string `yaml:"contact"`
	Maintainers []struct {
		Email string `yaml:"email"`
		Name  string `yaml:"name"`
	} `yaml:"maintainers"`
	Keywords     []string         `yaml:"keywords"`
	URL          string           `yaml:"url"`
	RulesURL     string           `yaml:"rules_url"`
	License      string           `yaml:"license"`
	Reserved     bool             `yaml:"reserved"`
	Capabilities Capabilities     `yaml:"capabilities"`
	Signature    *index.Signature `yaml:"signature,omitempty"`
}

func (*Plugin) Decode

func (r *Plugin) Decode(w io.Reader) error

Decode fills the structure by reading from a io.Reader

func (*Plugin) Encode

func (r *Plugin) Encode(w io.Writer) error

Encode writes the content to a io.Writer

func (*Plugin) String

func (r *Plugin) String() string

String implements the fmt.Stringer interface

type Registry

type Registry struct {
	Plugins         []Plugin `yaml:"plugins"`
	ReservedSources []string `yaml:"reserved_sources"`
}

func LoadRegistryFromFile

func LoadRegistryFromFile(fname string) (*Registry, error)

LoadRegistryFromFile loads the registry from a file on disk.

func (*Registry) Decode

func (r *Registry) Decode(w io.Reader) error

Decode fills the structure by reading from a io.Reader

func (*Registry) Encode

func (r *Registry) Encode(w io.Writer) error

Encode writes the content to a io.Writer

func (*Registry) String

func (r *Registry) String() string

String implements the fmt.Stringer interface

func (*Registry) Validate

func (r *Registry) Validate() error

Validates returns nil if the Registry is valid, and an error otherwise. For more details regarding which constraints are checked for validation, refer to: https://github.com/falcosecurity/plugins#registering-a-new-plugin

type RepositoryMetadata

type RepositoryMetadata struct {
	Ref string `json:"ref"`
}

type SourcingCapability

type SourcingCapability struct {
	Supported bool   `yaml:"supported"`
	ID        uint   `yaml:"id"`
	Source    string `yaml:"source"`
}

func (*SourcingCapability) Decode

func (r *SourcingCapability) Decode(w io.Reader) error

Decode fills the structure by reading from a io.Reader

func (*SourcingCapability) Encode

func (r *SourcingCapability) Encode(w io.Writer) error

Encode writes the content to a io.Writer

func (*SourcingCapability) String

func (r *SourcingCapability) String() string

String implements the fmt.Stringer interface