basic

Documentation

Index

• Constants
• Variables
• type CFeature
  • func (f *CFeature) AddBypassCIDR(cidr ...string) MakeFeature
  • func (f *CFeature) AddBypassIP(ip ...string) MakeFeature
  • func (f *CFeature) AddUserbase(usersProvider, groupsProvider, secretsProvider string) MakeFeature
  • func (f *CFeature) AuthenticateRequest(w http.ResponseWriter, r *http.Request) (handled bool, modified *http.Request)
  • func (f *CFeature) Build(b feature.Buildable) (err error)
  • func (f *CFeature) Ignore(patterns ...string) MakeFeature
  • func (f *CFeature) Init(this interface{})
  • func (f *CFeature) Make() Feature
  • func (f *CFeature) Protect(pattern, group string) MakeFeature
  • func (f *CFeature) ProtectAll(group string) MakeFeature
  • func (f *CFeature) RestrictServeData(data []byte, mime string, w http.ResponseWriter, r *http.Request) (modReq *http.Request, allow bool)
  • func (f *CFeature) RestrictServePage(pgCtx beContext.Context, w http.ResponseWriter, r *http.Request) (modCtx beContext.Context, modReq *http.Request, allow bool)
  • func (f *CFeature) SetAuthCacheControl(control string) MakeFeature
  • func (f *CFeature) SetLogoutPath(path string) MakeFeature
  • func (f *CFeature) SetLogoutRedirectPath(path string) MakeFeature
  • func (f *CFeature) SetRealm(realm string) MakeFeature
  • func (f *CFeature) Setup(enjin feature.Internals)
  • func (f *CFeature) Shutdown()
  • func (f *CFeature) Startup(ctx *cli.Context) (err error)
• type Feature
• type MakeFeature
  • func New() MakeFeature
  • func NewTagged(tag feature.Tag) MakeFeature

Constants

const (
	Tag            feature.Tag = "user-auth-basic"
	UserContextKey             = beContext.RequestKey("user-auth-basic-user-key")
)

Variables

var LogoutRedirectContentType = "text/html"

var LogoutRedirectResponseFormat = `` /* 138-byte string literal not displayed */

var UnauthContentType = "text/plain"

var UnauthResponse = "401 - " + http.StatusText(http.StatusUnauthorized)

Types

type CFeature

type CFeature struct {
	feature.CFeature
	// contains filtered or unexported fields
}

func (*CFeature) AddBypassCIDR

func (f *CFeature) AddBypassCIDR(cidr ...string) MakeFeature

func (*CFeature) AddBypassIP

func (f *CFeature) AddBypassIP(ip ...string) MakeFeature

func (*CFeature) AddUserbase

func (f *CFeature) AddUserbase(usersProvider, groupsProvider, secretsProvider string) MakeFeature

func (*CFeature) AuthenticateRequest

func (f *CFeature) AuthenticateRequest(w http.ResponseWriter, r *http.Request) (handled bool, modified *http.Request)

func (*CFeature) Build

func (f *CFeature) Build(b feature.Buildable) (err error)

func (*CFeature) Ignore

func (f *CFeature) Ignore(patterns ...string) MakeFeature

func (*CFeature) Init

func (f *CFeature) Init(this interface{})

func (*CFeature) Make

func (f *CFeature) Make() Feature

func (*CFeature) Protect

func (f *CFeature) Protect(pattern, group string) MakeFeature

func (*CFeature) ProtectAll

func (f *CFeature) ProtectAll(group string) MakeFeature

func (*CFeature) RestrictServeData

func (f *CFeature) RestrictServeData(data []byte, mime string, w http.ResponseWriter, r *http.Request) (modReq *http.Request, allow bool)

func (*CFeature) RestrictServePage

func (f *CFeature) RestrictServePage(pgCtx beContext.Context, w http.ResponseWriter, r *http.Request) (modCtx beContext.Context, modReq *http.Request, allow bool)

func (*CFeature) SetAuthCacheControl

func (f *CFeature) SetAuthCacheControl(control string) MakeFeature

func (*CFeature) SetLogoutPath

func (f *CFeature) SetLogoutPath(path string) MakeFeature

func (*CFeature) SetLogoutRedirectPath

func (f *CFeature) SetLogoutRedirectPath(path string) MakeFeature

func (*CFeature) SetRealm

func (f *CFeature) SetRealm(realm string) MakeFeature

func (*CFeature) Setup

func (f *CFeature) Setup(enjin feature.Internals)

func (*CFeature) Shutdown

func (f *CFeature) Shutdown()

func (*CFeature) Startup

func (f *CFeature) Startup(ctx *cli.Context) (err error)

type Feature

type Feature interface {
	feature.Feature
	userbase.AuthProvider
	feature.PageRestrictionHandler
	feature.DataRestrictionHandler
}

type MakeFeature

type MakeFeature interface {
	Make() Feature

	SetRealm(realm string) MakeFeature
	SetLogoutPath(path string) MakeFeature
	SetLogoutRedirectPath(path string) MakeFeature
	SetAuthCacheControl(control string) MakeFeature

	AddUserbase(usersProvider, groupsProvider, secretsProvider string) MakeFeature

	Ignore(patterns ...string) MakeFeature
	Protect(pattern, group string) MakeFeature
	ProtectAll(group string) MakeFeature
	AddBypassIP(ip ...string) MakeFeature
	AddBypassCIDR(cidr ...string) MakeFeature
}

func New

func New() MakeFeature

func NewTagged

func NewTagged(tag feature.Tag) MakeFeature