extractor

Documentation

Index

• Variables
• type Check
• type Config
  • func GetExtractorConfig(name string) (Config, error)
• type Extraction
• type Extractor
  • func MakeExtractor(name string, cfg Config) (Extractor, error)
  • func NewHeader(config *HeaderConfig) Extractor
  • func NewMock(cfg *MockConfig) Extractor
  • func NewRequestMethod(any) Extractor
  • func NewSpiffe(config *SpiffeConfig) Extractor
• type ExtractorKit
  • func (ek ExtractorKit) Extract(ctx context.Context, req *authv3.CheckRequest) (*Check, error)
• type HeaderConfig
  • func (c *HeaderConfig) UnmarshalMap(data any) error
• type MockConfig
• type SpiffeConfig

Variables

var ErrValueNotFound = errors.New("extraction value not found")

Types

type Check

type Check struct {
	User     string
	Relation string
	Object   string
	Context  map[string]any
}

type Config

type Config any

func GetExtractorConfig

func GetExtractorConfig(name string) (Config, error)

type Extraction

type Extraction struct {
	Value   string
	Context map[string]any
}

type Extractor

type Extractor func(ctx context.Context, value *authv3.CheckRequest) (Extraction, bool, error)

Extractor is the interface for extracting values from a CheckRequest.

func MakeExtractor

func MakeExtractor(name string, cfg Config) (Extractor, error)

func NewHeader

func NewHeader(config *HeaderConfig) Extractor

func NewMock

func NewMock(cfg *MockConfig) Extractor

func NewRequestMethod

func NewRequestMethod(any) Extractor

func NewSpiffe

func NewSpiffe(config *SpiffeConfig) Extractor

type ExtractorKit

type ExtractorKit struct {
	Name     string
	User     Extractor
	Object   Extractor
	Relation Extractor
}

func (ExtractorKit) Extract

func (ek ExtractorKit) Extract(ctx context.Context, req *authv3.CheckRequest) (*Check, error)

type HeaderConfig

type HeaderConfig struct {
	Name string `mapstructure:"name"`
}

func (*HeaderConfig) UnmarshalMap

func (c *HeaderConfig) UnmarshalMap(data any) error

type MockConfig

type MockConfig struct {
	Value   string         `mapstructure:"value"`
	Context map[string]any `mapstructure:"context"`
	Err     error          `mapstructure:"error"`
}

type SpiffeConfig

type SpiffeConfig struct {
	Type spiffeExtractionType `mapstructure:"type"`
}