authcache

Documentation

Overview

Package authcache provides explicit advisory cache adapters for portable policy manifests. Cached manifests never replace repository verification.

Index

• Variables
• func New(config Config) (*cache.Cache[authorization.Revision, policy.Manifest], error)
• func RepositoryLoader(repository policy.Repository) (cache.Loader[authorization.Revision, policy.Manifest], error)
• type Config
• type ManifestCodec
  • func (codec ManifestCodec) Decode(encoded []byte) (policy.Manifest, error)
  • func (codec ManifestCodec) Encode(manifest policy.Manifest) ([]byte, error)
• type RevisionKeyEncoder
  • func (RevisionKeyEncoder) EncodeKey(revision authorization.Revision) ([]byte, error)

Variables

var (
	ErrManifestTooLarge = errors.New("authorization cached manifest is too large")
	ErrInvalidRevision  = errors.New("authorization cached revision is invalid")
	ErrNilRepository    = errors.New("authorization cached repository is nil")
)

Functions

func New

func New(config Config) (*cache.Cache[authorization.Revision, policy.Manifest], error)

func RepositoryLoader

func RepositoryLoader(
	repository policy.Repository,
) (cache.Loader[authorization.Revision, policy.Manifest], error)

Types

type Config

type Config struct {
	Namespace  string
	Backend    cache.Backend
	TTL        cache.TTLPolicy
	Clock      cache.Clock
	Observer   cache.Observer
	MaxValue   int
	MaxBatch   int
	MaxKeySize int
}

type ManifestCodec

type ManifestCodec struct {
	MaxEncodedSize int
}

func (ManifestCodec) Decode

func (codec ManifestCodec) Decode(encoded []byte) (policy.Manifest, error)

func (ManifestCodec) Encode

func (codec ManifestCodec) Encode(manifest policy.Manifest) ([]byte, error)

type RevisionKeyEncoder

type RevisionKeyEncoder struct{}

func (RevisionKeyEncoder) EncodeKey

func (RevisionKeyEncoder) EncodeKey(revision authorization.Revision) ([]byte, error)