filters

Documentation

Index

• Constants
• func NewBasicAuthnFilter(repository storage.Repository) *filters.AuthenticationFilter
• func NewMultitenancyFilters(labelKey string, extractTenantFunc func(request *web.Request) (string, error)) []web.Filter
• func NewOIDCAuthnFilter(ctx context.Context, tokenIssuer, clientID string) (*filters.AuthenticationFilter, error)
• func NewRecoveryMiddleware() mux.MiddlewareFunc
• type BasicAuthenticator
  • func (a *BasicAuthenticator) Authenticate(request *http.Request) (*web.UserContext, httpsec.Decision, error)
• type Logging
  • func (*Logging) FilterMatchers() []web.FilterMatcher
  • func (*Logging) Name() string
  • func (l *Logging) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type PatchOnlyLabelsFilter
  • func (*PatchOnlyLabelsFilter) FilterMatchers() []web.FilterMatcher
  • func (*PatchOnlyLabelsFilter) Name() string
  • func (*PatchOnlyLabelsFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type PlanFilterByVisibility
  • func NewPlansFilterByVisibility(repository storage.Repository) *PlanFilterByVisibility
  • func (vf *PlanFilterByVisibility) FilterMatchers() []web.FilterMatcher
  • func (vf *PlanFilterByVisibility) Name() string
  • func (m PlanFilterByVisibility) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type PlatformAwareVisibilityFilter
  • func (*PlatformAwareVisibilityFilter) FilterMatchers() []web.FilterMatcher
  • func (*PlatformAwareVisibilityFilter) Name() string
  • func (*PlatformAwareVisibilityFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type ProtectedLabelsFilter
  • func NewProtectedLabelsFilter(forbiddenLabels []string) *ProtectedLabelsFilter
  • func (flo *ProtectedLabelsFilter) FilterMatchers() []web.FilterMatcher
  • func (flo *ProtectedLabelsFilter) Name() string
  • func (flo *ProtectedLabelsFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type SelectionCriteria
  • func (*SelectionCriteria) FilterMatchers() []web.FilterMatcher
  • func (*SelectionCriteria) Name() string
  • func (l *SelectionCriteria) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type ServicesFilterByVisibility
  • func NewServicesFilterByVisibility(repository storage.Repository) *ServicesFilterByVisibility
  • func (vf *ServicesFilterByVisibility) FilterMatchers() []web.FilterMatcher
  • func (vf *ServicesFilterByVisibility) Name() string
  • func (m ServicesFilterByVisibility) Run(req *web.Request, next web.Handler) (*web.Response, error)
• type TenantFilter
  • func (f *TenantFilter) FilterMatchers() []web.FilterMatcher
  • func (f *TenantFilter) Name() string
  • func (f *TenantFilter) Run(request *web.Request, next web.Handler) (*web.Response, error)

Constants

const BasicAuthnFilterName string = "BasicAuthnFilter"

const BearerAuthnFilterName string = "BearerAuthnFilter"

BearerAuthnFilterName is the name of the bearer authentication filter

const (
	// CriteriaFilterName is the name of the criteria filter
	CriteriaFilterName = "CriteriaFilter"
)

const (
	// LoggingFilterName is the name of the logging filter
	LoggingFilterName = "LoggingFilter"
)

const PatchOnlyLabelsFilterName = "PatchOnlyLabelsFilter"

const PlanVisibilityFilterName = "PlanFilterByVisibility"

const PlatformAwareVisibilityFilterName = "PlatformAwareVisibilityFilter"

const ProtectedLabelsFilterName = "ProtectedLabelsFilter"

const ServicesVisibilityFilterName = "ServicesFilterByVisibility"

const TenantCriteriaFilterName = "TenantCriteriaFilter"

sm-dev adopt and add new config properties in the dev en

const TenantLabelingFilterName = "TenantLabelingFilter"

Functions

func NewBasicAuthnFilter

func NewBasicAuthnFilter(repository storage.Repository) *filters.AuthenticationFilter

func NewMultitenancyFilters

func NewMultitenancyFilters(labelKey string, extractTenantFunc func(request *web.Request) (string, error)) []web.Filter

NewMultitenancyFilters returns set of filters which applies multitenancy rules

func NewOIDCAuthnFilter

func NewOIDCAuthnFilter(ctx context.Context, tokenIssuer, clientID string) (*filters.AuthenticationFilter, error)

NewOIDCAuthnFilter returns a web.Filter for Bearer authentication

func NewRecoveryMiddleware

func NewRecoveryMiddleware() mux.MiddlewareFunc

NewRecoveryMiddleware returns a standard mux middleware that provides panic recovery

Types

type BasicAuthenticator

type BasicAuthenticator struct {
	Repository storage.Repository
}

BasicAuthenticator for basic security

func (*BasicAuthenticator) Authenticate

func (a *BasicAuthenticator) Authenticate(request *http.Request) (*web.UserContext, httpsec.Decision, error)

Authenticate authenticates by using the provided Basic credentials

type Logging

type Logging struct {
}

Logging is filter that configures logging per request.

func (*Logging) FilterMatchers

func (*Logging) FilterMatchers() []web.FilterMatcher

FilterMatchers implements the web.Filter interface and returns the conditions on which the filter should be executed.

func (*Logging) Name

func (*Logging) Name() string

Name implements the web.Filter interface and returns the identifier of the filter.

func (*Logging) Run

func (l *Logging) Run(req *web.Request, next web.Handler) (*web.Response, error)

Run represents the logging middleware function that processes the request and configures the request-scoped logging.

type PatchOnlyLabelsFilter

type PatchOnlyLabelsFilter struct {
}

PatchOnlyLabelsFilter checks patch request for service offerings and plans include only label changes

func (*PatchOnlyLabelsFilter) FilterMatchers

func (*PatchOnlyLabelsFilter) FilterMatchers() []web.FilterMatcher

func (*PatchOnlyLabelsFilter) Name

func (*PatchOnlyLabelsFilter) Name() string

func (*PatchOnlyLabelsFilter) Run

func (*PatchOnlyLabelsFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)

type PlanFilterByVisibility

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

func NewPlansFilterByVisibility

func NewPlansFilterByVisibility(repository storage.Repository) *PlanFilterByVisibility

func (*PlanFilterByVisibility) FilterMatchers

func (vf *PlanFilterByVisibility) FilterMatchers() []web.FilterMatcher

func (*PlanFilterByVisibility) Name

func (vf *PlanFilterByVisibility) Name() string

func (PlanFilterByVisibility) Run

func (m PlanFilterByVisibility) Run(req *web.Request, next web.Handler) (*web.Response, error)

type PlatformAwareVisibilityFilter

type PlatformAwareVisibilityFilter struct {
}

func (*PlatformAwareVisibilityFilter) FilterMatchers

func (*PlatformAwareVisibilityFilter) FilterMatchers() []web.FilterMatcher

func (*PlatformAwareVisibilityFilter) Name

func (*PlatformAwareVisibilityFilter) Name() string

func (*PlatformAwareVisibilityFilter) Run

func (*PlatformAwareVisibilityFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)

type ProtectedLabelsFilter

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

ProtectedLabelsFilter checks for forbidden labels being modified/added

func NewProtectedLabelsFilter

func NewProtectedLabelsFilter(forbiddenLabels []string) *ProtectedLabelsFilter

NewProtectedLabelsFilter creates new filter for forbidden labels

func (*ProtectedLabelsFilter) FilterMatchers

func (flo *ProtectedLabelsFilter) FilterMatchers() []web.FilterMatcher

func (*ProtectedLabelsFilter) Name

func (flo *ProtectedLabelsFilter) Name() string

func (*ProtectedLabelsFilter) Run

func (flo *ProtectedLabelsFilter) Run(req *web.Request, next web.Handler) (*web.Response, error)

type SelectionCriteria

type SelectionCriteria struct {
}

SelectionCriteria is filter that configures selection criteria per request.

func (*SelectionCriteria) FilterMatchers

func (*SelectionCriteria) FilterMatchers() []web.FilterMatcher

FilterMatchers implements the web.Filter interface and returns the conditions on which the filter should be executed.

func (*SelectionCriteria) Name

func (*SelectionCriteria) Name() string

Name implements the web.Filter interface and returns the identifier of the filter.

func (*SelectionCriteria) Run

func (l *SelectionCriteria) Run(req *web.Request, next web.Handler) (*web.Response, error)

Run represents the selection criteria middleware function that processes the request and configures the request-scoped selection criteria.

type ServicesFilterByVisibility

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

func NewServicesFilterByVisibility

func NewServicesFilterByVisibility(repository storage.Repository) *ServicesFilterByVisibility

func (*ServicesFilterByVisibility) FilterMatchers

func (vf *ServicesFilterByVisibility) FilterMatchers() []web.FilterMatcher

func (*ServicesFilterByVisibility) Name

func (vf *ServicesFilterByVisibility) Name() string

func (ServicesFilterByVisibility) Run

func (m ServicesFilterByVisibility) Run(req *web.Request, next web.Handler) (*web.Response, error)

type TenantFilter

type TenantFilter struct {
	// LabelKey is the key of the label, the value of which will be used to apply multitenancy rules
	LabelKey string

	ExtractTenant func(request *web.Request) (string, error)
	LabelingFunc  func(request *web.Request, labelKey, labelValue string) error

	FilterName string
	Methods    []string
}

TenantFilter applies multitenancy labeling on the resources based on extracted tenant

func (*TenantFilter) FilterMatchers

func (f *TenantFilter) FilterMatchers() []web.FilterMatcher

FilterMatchers implements web.Filter.FilterMatchers and specifies that the filter should run on configured method

func (*TenantFilter) Name

func (f *TenantFilter) Name() string

Name implements web.Named and returns the filter name

func (*TenantFilter) Run

func (f *TenantFilter) Run(request *web.Request, next web.Handler) (*web.Response, error)

Run implements web.Middleware and attempts to extract tenant and apply labeling function