finalizers

Documentation

Index

• Constants
• Variables
• type CreationContext
• type Finalizer
  • func CreatePrototype(ctx CreationContext, id string, typ string, mConfig map[string]any) (Finalizer, error)
• type KeyStore
• type SignerConfig
• type TypeFactory

Constants

const (
	FinalizerNoop                    = "noop"
	FinalizerJwt                     = "jwt"
	FinalizerHeader                  = "header"
	FinalizerCookie                  = "cookie"
	FinalizerOAuth2ClientCredentials = "oauth2_client_credentials" // nolint: gosec
)

Variables

var (
	ErrUnsupportedType = errors.New("finalizer type unsupported")
)

Types

type CreationContext

type CreationContext interface {
	Watcher() watcher.Watcher
	KeyHolderRegistry() keyholder.Registry
	CertificateObserver() certificate.Observer
}

type Finalizer

type Finalizer interface {
	ID() string
	Execute(ctx heimdall.Context, sub *subject.Subject) error
	WithConfig(config map[string]any) (Finalizer, error)
	ContinueOnError() bool
}

func CreatePrototype

func CreatePrototype(ctx CreationContext, id string, typ string, mConfig map[string]any) (Finalizer, error)

type KeyStore

type KeyStore struct {
	Path     string `mapstructure:"path"     validate:"required"`
	Password string `mapstructure:"password"`
}

type SignerConfig

type SignerConfig struct {
	Name     string   `mapstructure:"name"`
	KeyStore KeyStore `mapstructure:"key_store" validate:"required"`
	KeyID    string   `mapstructure:"key_id"`
}

type TypeFactory

type TypeFactory func(ctx CreationContext, id string, typ string, c map[string]any) (bool, Finalizer, error)