clientid

Documentation

Index

• Variables
• type ClientID
• type Middleware
  • func New(opts ...Option) *Middleware
  • func (m *Middleware) IgnoreRoute(route *mux.Route) *Middleware
  • func (m *Middleware) Middleware() func(http.Handler) http.Handler
• type Option
  • func WithEnforcmentPolicy(p enforcement.Policy) Option
  • func WithExtractor(e extractor.Extractor) Option
  • func WithHeaderExtractor(headers ...string) Option
  • func WithRequired() Option
  • func WithS3Store(awsCfg aws.Config, arn string) Option
  • func WithStage(stages ...string) Option
  • func WithStore(s Store) Option
  • func WithStoreCache() Option
• type Store

Variables

var FromContext = models.FromContext

Types

type ClientID

type ClientID = models.ClientID

type Middleware

type Middleware struct {
	Tracer middleware.Tracer
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Middleware

New returns a new Client ID middleware which embedds an valid client ID if provided in the request. Without providing any Options the client id is extracted from the request header "X-Client-ID", is optional and, using an empty in-memory store.

func (*Middleware) IgnoreRoute

func (m *Middleware) IgnoreRoute(route *mux.Route) *Middleware

func (*Middleware) Middleware

func (m *Middleware) Middleware() func(http.Handler) http.Handler

type Option

type Option func(*Middleware)

func WithEnforcmentPolicy

func WithEnforcmentPolicy(p enforcement.Policy) Option

func WithExtractor

func WithExtractor(e extractor.Extractor) Option

func WithHeaderExtractor

func WithHeaderExtractor(headers ...string) Option

func WithRequired

func WithRequired() Option

func WithS3Store

func WithS3Store(awsCfg aws.Config, arn string) Option

func WithStage

func WithStage(stages ...string) Option

func WithStore

func WithStore(s Store) Option

func WithStoreCache

func WithStoreCache() Option

type Store

type Store = store.Store