cbwebauth

Documentation

Index

• Variables
• type Acl
  • func (a *Acl) Middleware(permittedPermissions []string, redirect string) func(ctx *fasthttp.RequestCtx) (bool, error)
  • func (a *Acl) Permitted(userPermissions, permittedPermissions []string) bool
  • func (a *Acl) PermittedCtx(ctx *fasthttp.RequestCtx, permittedPermissions []string) bool
• type Config
• type Container
  • func New(config Config) *Container
  • func (c *Container) AuthMiddleware(ctx *fasthttp.RequestCtx) (bool, error)
  • func (c *Container) ChangePassword(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)
  • func (c *Container) GetUniqueIdentifier(providerName string, ctx *fasthttp.RequestCtx) (string, error)
  • func (c *Container) IsAuthenticated(providerName string, ctx *fasthttp.RequestCtx) (bool, error)
  • func (c *Container) Login(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)
  • func (c *Container) Logout(providerName string, ctx *fasthttp.RequestCtx, redirect string) (bool, error)
  • func (c *Container) Register(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)
• type Provider

Variables

var (
	LoggedIn  = "logged-in"
	LoggedOut = "logged-out"
)

var (
	AclDeniedUriPlaceholder = ":acl_denied_uri:"
)

Types

type Acl

type Acl struct {
	Auth *Container
}

func (*Acl) Middleware

func (a *Acl) Middleware(permittedPermissions []string, redirect string) func(ctx *fasthttp.RequestCtx) (bool, error)

func (*Acl) Permitted

func (a *Acl) Permitted(userPermissions, permittedPermissions []string) bool

func (*Acl) PermittedCtx

func (a *Acl) PermittedCtx(ctx *fasthttp.RequestCtx, permittedPermissions []string) bool

type Config

type Config struct {
	Providers               []Provider
	UnauthorisedRedirectUri string
	LogoutRedirectUri       string
}

type Container

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

func New

func New(config Config) *Container

func (*Container) AuthMiddleware

func (c *Container) AuthMiddleware(ctx *fasthttp.RequestCtx) (bool, error)

func (*Container) ChangePassword

func (c *Container) ChangePassword(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)

func (*Container) GetUniqueIdentifier

func (c *Container) GetUniqueIdentifier(providerName string, ctx *fasthttp.RequestCtx) (string, error)

func (*Container) IsAuthenticated

func (c *Container) IsAuthenticated(providerName string, ctx *fasthttp.RequestCtx) (bool, error)

func (*Container) Login

func (c *Container) Login(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)

func (*Container) Logout

func (c *Container) Logout(providerName string, ctx *fasthttp.RequestCtx, redirect string) (bool, error)

func (*Container) Register

func (c *Container) Register(providerName string, ctx *fasthttp.RequestCtx) (bool, error, map[string]error)

type Provider

type Provider interface {
	GetProviderName() string
	GetUniqueIdentifier(ctx *fasthttp.RequestCtx) string
	GetPermissions(ctx *fasthttp.RequestCtx) []string
	IsAuthenticated(ctx *fasthttp.RequestCtx) bool
	Login(ctx *fasthttp.RequestCtx) (bool, map[string]error)
	Logout(ctx *fasthttp.RequestCtx) bool
	Register(ctx *fasthttp.RequestCtx) (bool, map[string]error)
	ChangePassword(ctx *fasthttp.RequestCtx) (bool, map[string]error)
}